Skip to content

Commit

Permalink
docs: Add docs for length, offset option again (lost in merge)
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
Ljzd-PRO committed Apr 6, 2024
1 parent 4439af5 commit a98f920
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ the downloaded files will be **skipped**.
# Download all posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016

# Download latest 10 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# Download latest No.11-No.15 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5

# Download posts from the creator/artist from 2024-1-1 to 2024-3-1
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1
```
Expand Down
6 changes: 6 additions & 0 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,12 @@ ktoolbox download-post https://kemono.su/fanbox/user/49494721/post/6608808
# 下载作者/画师的所有作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016

# 下载作者/画师最新的 10 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# 下载作者/画师最新的第 11 至 15 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5

# 下载作者/画师从 2024-1-1 到 2024-3-1 的作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1
```
Expand Down
15 changes: 15 additions & 0 deletions docs/en/commands/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,21 @@ ktoolbox sync-creator https://kemono.su/fanbox/user/9016
??? tip "Update creator directory"
You can rerun the command, files with the same filename will be skipped.

## Download a specified number of posts from the creator

`sync-creator`

- `--offset`: Posts result offset (or start offset)
- `--length`: The number of posts to fetch, defaults to fetching all posts

```bash
# Download latest 10 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# Download latest No.11-No.15 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5
```

## Download posts that published within the specified time range

`sync-creator`
Expand Down
6 changes: 6 additions & 0 deletions docs/en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ ktoolbox download-post https://kemono.su/fanbox/user/49494721/post/6608808
# Download all posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016

# Download latest 10 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# Download latest No.11-No.15 posts of the creator/artist
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5

# Download posts from the creator/artist from 2024-1-1 to 2024-3-1
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1
```
Expand Down
15 changes: 15 additions & 0 deletions docs/zh/commands/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,21 @@ ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5
??? tip "更新作者目录"
你可以再次运行命令,文件名相同的文件将会被跳过。

## 下载指定数量的作品

`sync-creator`

- `--offset`:作品结果偏移量(或起始偏移量)
- `--length`:要获取的作品数量,默认获取所有作品

```bash
# 下载作者/画师最新的 10 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# 下载作者/画师最新的第 11 至 15 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5
```

## 下载在指定时间范围内发布的作品

`sync-creator`
Expand Down
6 changes: 6 additions & 0 deletions docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ ktoolbox download-post https://kemono.su/fanbox/user/49494721/post/6608808
# 下载作者/画师的所有作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016

# 下载作者/画师最新的 10 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --length=10

# 下载作者/画师最新的第 11 至 15 个作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --offset=10 --length=5

# 下载作者/画师从 2024-1-1 到 2024-3-1 的作品
ktoolbox sync-creator https://kemono.su/fanbox/user/9016 --start-time=2024-1-1 --end-time=2024-3-1
```
Expand Down

0 comments on commit a98f920

Please sign in to comment.