Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 3.1 KB

README.md

File metadata and controls

87 lines (63 loc) · 3.1 KB
Raw

cli

Build codecov docs.rs Crates.io Crates.io

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

cargo install novel-cli

If you compile it yourself, you need the following dependencies:

  • Clang
  • CMake

If you are using Windows, you also need:

  • NASM

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 <bookid> --source <app-source> --format <output-format>
  • Search for a novel from source 
      novel-cli search --source <SOURCE> <KEYWORD>

Commands

  • download: Download novels from various sources.
  • search: Search for novels on various sources.
  • info: Print information about a novel on various sources.
  • favorites: 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).

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