Skip to content

Commit

Permalink
add usage
Browse files Browse the repository at this point in the history
  • Loading branch information
elvis972602 committed Feb 5, 2023
1 parent 90f248a commit cc8c997
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,61 @@ A simple scraper to filter and download images from kemono.party
## Downloader Released
Source code is in `./main`

## Usage

### Download Option
`--link [<urls>]`
download link, should be same site, separate by comma
`--creator [<service>:<id>]`
download creators, separate by comma
`--banner bool`

### Post Filter Option
`--first int`
download first n post
`--last int`
download last n post
`--date YYYYMMDD`
download post on date
`--date-before YYYYMMDD`
download post before date
`--date-after YYYYMMDD`
download post after date
`--update YYYYMMDD`
download post updated on date
`--update-before YYYYMMDD`
download post updated before date
`--update-after YYYYMMDD`

### Image Filter Option
download post updated after date
`--extensionOnly [<ext>]`
download post with extension, separate by comma
`--extensionExcept [<ext>]`
download post without extension, separate by comma

### Downloader Option
`--output PATH`
output path
`--overwrite bool`
overwrite existing file
`--async bool`
download posts asynchronously, may cause the file order is not the same as the post order, can be used with --with-prefix-number, default false
`--max-download-parallel int`
max download file concurrent, default is 3, async mode only
`--with-prefix-number bool`
add prefix number to file name `<order>-<filename>`, default false
`--name-rule-only-index bool`
only use index as file name, default false
`--download-timeout int`
download timeout in seconds, default 300
`--retry int`
retry times, default 3
`--retry-interval int`
retry interval in seconds, default 10
`--rate-limit int`
rate limit in request/s, default 2

## Features
With Kemono-scraper, you can implement a Downloader to take advantage of features such as multi-connection downloading, resume broken downloads, and more.

0 comments on commit cc8c997

Please sign in to comment.