31 releases (10 breaking)
new 0.11.9 | Nov 14, 2024 |
---|---|
0.11.6 | Sep 9, 2024 |
0.11.3 | Jul 18, 2024 |
0.5.0 | Jul 31, 2023 |
0.1.4 | Jan 27, 2023 |
#405 in Command line utilities
354 downloads per month
200KB
5K
SLoC
cli
A set of tools for downloading novels from the web, manipulating text, and generating EPUB
Platform
- Windows
- Linux
- macOS
Installation
You can download the compiled file from release, or compile it yourself
# Download the source code from https://crates.io
cargo install novel-cli
# Or download the source code from GitHub
git clone https://github.com/novel-rs/cli
cd cli
cargo build --release
If you compile it yourself, you need the following dependencies:
- Clang
- CMake
- Python / Python3
The novel-cli build subcommand requires pandoc
The novel-cli real-cugan subcommand requires realcugan-ncnn-vulkan
Usage
You can run novel-cli help
to view help information
Examples
- The basic format of the command is:
novel-cli [OPTIONS] <COMMAND> [COMMAND-OPTIONS] [ARGUMENTS]
- Download a novel from source in format
novel-cli download <novel_id> --source <source> --format <output_format>
- Search for a novel from source
novel-cli search --source <source> <keyword>
Commands
sign
: Sign in and display the current amount of moneydownload
: Download novelsearch
: Search novelsinfo
: Show novel informationread
: Read novelbookshelf
: Show novels in the bookshelftemplate
: Generate pandoc-style markdown file templatetransform
: Transform pandoc-style markdown filecheck
: Check pandoc-style markdown file format and contentbuild
: Build novel from pandoc-style markdown file or mdBook folderzip
: Zip an EPUB folderunzip
: Unzip an EPUB filereal-cugan
: Run realcugan-ncnn-vulkan to super-resolution imagesupdate
: Check for updates, download file from GitHub, and replacecompletions
: Generate shell completion to stdouthelp
: Print this message or the help of the given subcommand(s)
Options
-v, --verbose
: Use verbose output. This option provides more detailed output-q, --quiet
: Do not print logs (default: false). This option suppresses logging output--backtrace
: Print backtrace information. This option displays the backtrace information-h, --help
: Print help. This option displays the help information-V, --version
: Print version. This option prints the version information
Contributing
You should read CONTRIBUTING first
License
All the code in this repository is released under Apache License 2.0 and MIT license
Dependencies
~105–145MB
~2.5M SLoC