#novel #sfacg #ciweimao

bin+lib novel-cli

Download novels from sfacg and ciweimao

7 releases (4 breaking)

0.5.0 Jul 31, 2023
0.4.0 Jul 11, 2023
0.3.8 Jun 12, 2023
0.3.0 May 24, 2023
0.1.4 Jan 27, 2023

#1215 in Command line utilities

Download history 2/week @ 2023-11-06 4/week @ 2023-11-13 40/week @ 2023-11-20 56/week @ 2023-11-27 20/week @ 2023-12-04 19/week @ 2023-12-11 2/week @ 2023-12-18 37/week @ 2023-12-25 9/week @ 2024-01-01 3/week @ 2024-01-15 1/week @ 2024-01-22 37/week @ 2024-01-29 1/week @ 2024-02-05 544/week @ 2024-02-12 320/week @ 2024-02-19

903 downloads per month

MIT/Apache and LGPL-3.0-or-later



Build codecov docs.rs MSRV Crates.io Crates.io GitHub Downloads

A set of tools for downloading novels from the web, manipulating text, and generating EPUB


  • Windows
  • Linux
  • macOS


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
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


You can run novel-cli help to view help information


  • The basic format of the command is:
  • Download a novel from source in format
novel-cli download <bookid> --source <app-source> --format <output-format>
  • Search for a novel from source
novel-cli search --source <SOURCE> <KEYWORD>


  • download: Download novels from various sources.
  • search: Search for novels on various sources.
  • info: Print information about a novel on various sources.
  • read: Read novel from various sources.
  • bookshelf: Show saved favorite novels on various sources.
  • transform: Convert markdown files to pandoc style.
  • check: Check the format and content of pandoc style markdown files.
  • build: Build a novel from pandoc style markdown files or an mdBook folder.
  • zip: Compress an epub folder.
  • unzip: Decompress an epub file.
  • real-cugan: Run the realcugan-ncnn-vulkan program.
  • update: Check for updates, download files from GitHub, and replace them.
  • completions: Generate shell completions to standard output.
  • help: Print this message or the help of the given subcommand(s).


  • -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.


You should read CONTRIBUTING first


All the code in this repository is released under Apache License 2.0 and MIT license


~3M SLoC