Commands Reference
This page documents every active command exposed by web-novel-scraper
web-novel-scraper
CLI Tool for web novel scraping.
Usage
web-novel-scraper [OPTIONS] COMMAND [ARGS]...
Options
- --request-time-between-retries <request_time_between_retries>
Number of seconds that will pass between retries for every request.
- --request-timeout <request_timeout>
Timeout for every request in seconds.
- --request-retries <request_retries>
Number of maximum retries for every request.
- --force-flaresolver
Only Flaresolver will be used for every request
- --decode-guide-file <decode_guide_file>
Path to alternative decode guide file.
- --base-novels-dir <base_novels_dir>
Alternative base directory for all novels.
- --config-file <config_file>
Path to config file.
- -nb, --novel-base-dir <novel_base_dir>
Alternative directory for this novel.
create-novel
Creates a new novel and saves it.
Usage
web-novel-scraper create-novel [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --toc-main-url <toc_main_url>
Required Main URL of the TOC, required if not loading from file.
- --host <host>
Host used for decoding, optional if toc-main-url is provided.
- --author <author>
Name of the novel author.
- --start-date <start_date>
Start date of the novel, should be in the format YYYY-MM-DD, YYYY-MM or YYYY.
- --end-date <end_date>
End date of the novel, should be in the format YYYY-MM-DD, YYYY-MM or YYYY.
- --language <language>
Language of the novel.
- --description <description>
Description of the novel.
- --tag <tags>
Novel tag, you can add multiple of them.
- --cover <cover>
Path of the image to be used as cover.
- --title-in-content <title_in_content>
If the title should be added to the chapter content, overrides the host default option.
- Options:
YES | SEARCH | NO
- --auto-add-host
Automatically add the host to chapter URLs.
- Default:
False
- --force-flaresolver
Force the use of FlareSolver for requests.
- Default:
False
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
request-all-chapters
Request all chapters of a novel.
Usage
web-novel-scraper request-all-chapters [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --sync-toc
Reload the TOC before requesting chapters.
- --update-html, --no-update-html
If the chapter HTML is saved, it will be updated.
- Default:
False
- --clean-chapters
If the chapter HTML should be cleaned upon saving.
- Default:
False
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
save-novel-to-epub
Save the novel to EPUB format.
Usage
web-novel-scraper save-novel-to-epub [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --sync-toc
Reload the TOC before requesting chapters.
- --start-chapter <start_chapter>
The start chapter for the books (position in the TOC, may differ from the actual number).
- Default:
1
- --end-chapter <end_chapter>
The end chapter for the books (if not defined, every chapter will be saved).
- --chapters-by-book <chapters_by_book>
The number of chapters each book will have.
- Default:
100
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
save-novel-to-html
Save the novel to EPUB format.
Usage
web-novel-scraper save-novel-to-html [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --sync-toc
Reload the TOC before requesting chapters.
- --start-chapter <start_chapter>
The start chapter for the books (position in the TOC, may differ from the actual number).
- Default:
1
- --end-chapter <end_chapter>
The end chapter for the books (if not defined, every chapter will be saved).
- --chapters-by-book <chapters_by_book>
The number of chapters each book will have.
- Default:
100
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
save-novel-to-txt
Save the novel to EPUB format.
Usage
web-novel-scraper save-novel-to-txt [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --sync-toc
Reload the TOC before requesting chapters.
- --start-chapter <start_chapter>
The start chapter for the books (position in the TOC, may differ from the actual number).
- Default:
1
- --end-chapter <end_chapter>
The end chapter for the books (if not defined, every chapter will be saved).
- --chapters-by-book <chapters_by_book>
The number of chapters each book will have.
- Default:
100
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
scrap-chapter
Scrap a chapter of a novel.
Usage
web-novel-scraper scrap-chapter [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --chapter-url <chapter_url>
Chapter URL to be scrapped.
- --chapter-num <chapter_num>
Chapter number to be scrapped.
- --update-html
If the chapter HTML is saved, it will be updated.
- Default:
False
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
set-cover-image
Set the cover image for a novel.
Usage
web-novel-scraper set-cover-image [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --cover-image <cover_image>
Required Filepath of the cover image.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
set-host
Set the host for a novel.
Usage
web-novel-scraper set-host [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --host <host>
Host used for decoding, optional if toc-main-url is provided.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
set-metadata
Set metadata for a novel.
Usage
web-novel-scraper set-metadata [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --author <author>
Name of the novel author.
- --start-date <start_date>
Start date of the novel, should be in the format YYYY-MM-DD, YYYY-MM or YYYY.
- --end-date <end_date>
End date of the novel, should be in the format YYYY-MM-DD, YYYY-MM or YYYY.
- --language <language>
Language of the novel.
- --description <description>
Description of the novel.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
set-scraper-behavior
Set scraper behavior for a novel.
Usage
web-novel-scraper set-scraper-behavior [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --title-in-content <title_in_content>
If the title should be added to the chapter content, overrides the host default option.
- Options:
YES | SEARCH | NO
- --auto-add-host <auto_add_host>
Toggle automatic addition of the host to chapter URLs (use true or false).
- --force-flaresolver <force_flaresolver>
Toggle forcing the use of FlareSolver (use true or false).
- --hard-clean <hard_clean>
Toggle using a hard clean when cleaning HTML files (use true or false).
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
set-toc-main-url
Set the main URL for the TOC of a novel, will delete all chapter information from previous TOC.
Usage
web-novel-scraper set-toc-main-url [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --toc-main-url <toc_main_url>
Required New TOC main URL (Previous links will be deleted).
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-chapters
Show chapters of a novel.
Usage
web-novel-scraper show-chapters [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-metadata
Show metadata of a novel.
Usage
web-novel-scraper show-metadata [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-novel-dir
Show the directory where the novel is saved.
Usage
web-novel-scraper show-novel-dir [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-novel-info
Show information about a novel.
Usage
web-novel-scraper show-novel-info [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-scraper-behavior
Show scraper behavior of a novel.
Usage
web-novel-scraper show-scraper-behavior [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
show-toc
Show the TOC of a novel.
Usage
web-novel-scraper show-toc [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
sync-toc
Sync the TOC of a novel.
Usage
web-novel-scraper sync-toc [OPTIONS]
Options
- -t, --title <title>
Required Title of the novel, this server as the identifier.
- --reload-files, --no-reload-files
Whether to request again the TOC files (will make the request if there are no files anyway).
- Default:
True
Environment variables
- SCRAPER_NOVEL_TITLE
Provide a default for
-t
version
Shows the program version.
Usage
web-novel-scraper version [OPTIONS]