Skip to content

Mikowmer/fichub-cli

 
 

Repository files navigation

fichub-cli

A CLI for the fichub.net API

To report issues upstream for the supported sites, visit https://fichub.net/#contact

To report issues for the CLI, open an issue at https://github.com/FicHub/fichub-cli/issues

Installation

Using pip (Recommended)

pip install -U fichub-cli

From Source (Might have bugs, for testing only)

pip install git+https://github.com/FicHub/fichub-cli@main

Usage

> fichub_cli
Usage: fichub_cli [OPTIONS] COMMAND [ARGS]...

  A CLI for the fichub.net API

  To report issues upstream for supported sites, visit
  https://fichub.net/#contact

  To report issues for the CLI, open an issue at
  https://github.com/FicHub/fichub-cli/issues

  Failed downloads will be saved in the `err.log` file in the current
  directory.

Options:
  -u, --url TEXT            The url of the fanfiction enclosed within quotes
  -i, --infile TEXT         Path to a file to read URLs from
  -l, --list-url TEXT       Enter a comma separated list of urls to download, enclosed within quotes
  -v, --verbose             Verbose
  -o,  --out-dir TEXT       Path to the Output directory for files (default: Current Directory)
  --format TEXT             Download Format: epub (default), mobi, pdf or html [default: epub]
  --force / --no-force      Force overwrite of an existing file  [default: no-force]
  --get-urls TEXT           Get all story urls found from a page. Currently supports archiveofourown.org only
  -ss, --supported-sites    List of supported sites
  -d,  --debug              Show the log in the console for debugging
  --log / --no-log          Save the logfile for debugging  [default: no-log]
  --version / --no-version  Display version & quit  [default: no-version]
  --help                    Show this message and exit.

Default Configuration

  • The fanfiction will be downloaded in epub format. To change it, use -f followed by the format.
  • The fanfiction will be downloaded in the current directory. To change it, use -o followed by the path to the directory.
  • Failed downloads will be saved in the err.log file in the current directory.

Check fichub_cli --help for more info.

Example

  • To download using an URL
fichub_cli -u https://archiveofourown.org/works/10916730/chapters/24276864
  • To download using a file containing URLs
fichub_cli -i urls.txt
  • To download using a comma separated list of URLs
fichub_cli -l "https://www.fanfiction.net/s/11191235/1/Harry-Potter-and-the-Prince-of-Slytherin,https://www.fanfiction.net/s/13720575/1/A-Cadmean-Victory-Remastered"

NOTE --out-dir or -o can be used in all the above commands to select an output directory.


  • To get all story urls found from a page. Currently supports archiveofourown.org only.
fichub_cli --get-urls https://archiveofourown.org/users/flamethrower/

Plugin Support

Read the wiki for more info.

Links

About

A CLI for the fichub.net API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%