Skip to content

Commit 6bead4e

Browse files
CosmicPredatorCosmicPredator
committed
- 📝 Update and Complete Docs
1 parent a056eab commit 6bead4e

File tree

9 files changed

+385
-7
lines changed

9 files changed

+385
-7
lines changed

‎docs/.vitepress/config.mts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,12 @@ export default defineConfig({
3131
text: "CLI Guide",
3232
items: [
3333
{ text: "help", link: "/02_cli_guide/help" },
34-
{ text: "login", link: "/02_cli_guide/login" }
34+
{ text: "login", link: "/02_cli_guide/login" },
35+
{ text: "profile", link: "/02_cli_guide/profile" },
36+
{ text: "ls", link: "/02_cli_guide/ls" },
37+
{ text: "search", link: "/02_cli_guide/search" },
38+
{ text: "add", link: "/02_cli_guide/add" },
39+
{ text: "update", link: "/02_cli_guide/update" }
3540
]
3641
}
3742
],

‎docs/02_cli_guide/add.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Add
3+
lang: en-US
4+
---
5+
6+
# The `add` Command
7+
8+
The `chibi add` command allows you to add an anime or manga to your list. You can specify the entry by its ID and set its initial status.
9+
10+
## Usage
11+
```bash
12+
$ chibi add [id] [flags]
13+
```
14+
15+
## Flags
16+
17+
### `-h, --help`
18+
Provides help information for the `chibi add` command. Use this flag to display details about how the command works.
19+
20+
#### Example:
21+
```bash
22+
$ chibi add --help
23+
```
24+
25+
### `-s, --status string`
26+
Specifies the status of the media you are adding to your list. You can use either the full name or shorthand notation. The available status options are:
27+
28+
- `watching` or `w`: Currently watching anime or reading manga.
29+
- `planning` or `p`: Planning to watch or read in the future (default).
30+
- `completed` or `c`: Finished watching or reading.
31+
- `dropped` or `d`: Dropped media that you don't plan to continue.
32+
- `paused` or `ps`: Temporarily paused media.
33+
- `repeating` or `rp`: Media you are rewatching or rereading.
34+
35+
#### Example:
36+
```bash
37+
$ chibi add 1234 --status watching
38+
```
39+
This command adds the entry with ID `1234` to your list with a status of `watching`.
40+
41+
## Parameters
42+
43+
### `[id]`
44+
The unique identifier of the anime or manga entry you want to add. This is a required parameter.
45+
46+
#### Example:
47+
```bash
48+
$ chibi add 5678 --status planning
49+
```
50+
This command adds the entry with ID `5678` to your list with the default status of `planning`.
51+
52+
## Defaults
53+
- The default `status` is `planning` if not specified.
54+
55+
### Example of Default Usage
56+
```bash
57+
$ chibi add 4321
58+
```
59+
This command adds the entry with ID `4321` to your list with a status of `planning`.
60+
61+
## Example Usage
62+
63+
### Add with Specific Status
64+
To add a manga to your list and set its status as `reading`:
65+
```bash
66+
$ chibi add 7890 --status reading
67+
```
68+
69+
### Add with Default Status
70+
To add an anime to your list with the default status (`planning`):
71+
```bash
72+
$ chibi add 9876
73+
```
74+
75+
### Help Flag
76+
To learn more about the command:
77+
```bash
78+
$ chibi add --help
79+
```
80+
81+
## Output
82+
Upon successful execution, the command will confirm the addition with a message like the following:
83+
```bash
84+
Done ✅
85+
```

‎docs/02_cli_guide/help.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ $ chibi --help
1717
# Available Commands:
1818
# add Add a media to your list
1919
# help Help about any command
20+
# list List your current anime/manga list
2021
# login Login with anilist
21-
# ls List your current anime/manga list
2222
# profile Get's your AniList profile (requires login)
2323
# search Search for anime and manga
2424
# update Update a list entry
2525

2626
# Flags:
27-
# -h, --help help for chibi
27+
# -h, --help help for chibi
28+
# -v, --version Prints the version of the app
2829

2930
# Use "chibi [command] --help" for more information about a command.
3031
```

‎docs/02_cli_guide/login.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ Invoke the `login` command by running the following:
1212
$ chibi login
1313
# Open the below link in browser to login with anilist:
1414

15-
# https://anilist.co/api/v2/oauth/authorize?client_id=4593&response_type=token
15+
# ╭──────────────────────────────────────────────────────────────────────────────╮
16+
# │ https://anilist.co/api/v2/oauth/authorize?client_id=4593&response_type=token │
17+
# ╰──────────────────────────────────────────────────────────────────────────────╯
1618

17-
# Copy the code from the browser and enter it below:
18-
# Enter code:
19+
# ┃ Paste your token here:
20+
# ┃
21+
# ┃
1922
```
2023
This will display a URL. You can copy and paste this URL into your browser, or simply `Ctrl + Click` the link to open it directly.
2124

‎docs/02_cli_guide/ls.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Ls
3+
lang: en-US
4+
---
5+
6+
# The `ls` Command
7+
8+
The `chibi ls` command is used to retrieve a list of anime or manga based on the specified type and status. It supports detailed filtering options to help you find media you are currently engaging with, planning to watch or read, or have already completed.
9+
10+
## Usage
11+
```bash
12+
$ chibi list [flags]
13+
```
14+
15+
### Aliases
16+
The command supports the following aliases for convenience:
17+
- `list`
18+
- `ls`
19+
20+
## Flags
21+
22+
### `-h, --help`
23+
Provides help information for the `chibi list` command. Use this flag to display details about how the command works and the options available.
24+
25+
```bash
26+
$ chibi list --help
27+
```
28+
29+
### `-s, --status string`
30+
Filters the media list based on its current status. You can use the full status name or the shorthand notation for ease of use. The available status options are:
31+
32+
- `watching` or `w`: Currently watching anime or reading manga.
33+
- `planning` or `p`: Planning to watch or read in the future.
34+
- `completed` or `c`: Finished watching or reading.
35+
- `dropped` or `d`: Dropped media that you don't plan to continue.
36+
- `paused` or `ps`: Temporarily paused media.
37+
- `repeating` or `rp`: Media you are rewatching or rereading.
38+
39+
#### Example:
40+
```bash
41+
chibi list --status completed
42+
```
43+
44+
### `-t, --type string`
45+
Specifies the type of media to list. Use the full name or shorthand notation:
46+
47+
- `anime` or `a`: Filters for anime.
48+
- `manga` or `m`: Filters for manga.
49+
50+
If no type is specified, the default type is `anime`.
51+
52+
#### Example:
53+
```bash
54+
chibi list --type manga
55+
```
56+
57+
### Combined Example
58+
You can combine `--status` and `--type` flags to further narrow your results. For instance:
59+
60+
```bash
61+
chibi list --status watching --type anime
62+
```
63+
64+
This command will display a list of anime that you are currently watching.
65+
66+
## Defaults
67+
- The default `status` is `watching`.
68+
- The default `type` is `anime`.
69+
70+
### Example of Default Usage
71+
```bash
72+
chibi list
73+
```
74+
This command will list anime that you are currently watching by default.
75+
76+
### Output
77+
The output of the `chibi list` command is a detailed list of media that matches the specified criteria, including information like the title, progress, and any additional metadata associated with the media.
78+
79+
```bash
80+
┌──────────┬────────────────────────────────────┬────────┐
81+
│ ID │ TITLE │PROGRESS│
82+
├──────────┼────────────────────────────────────┼────────┤
83+
│ 107660 │ BEASTARS │ 2/12 │
84+
└──────────┴────────────────────────────────────┴────────┘
85+
```

‎docs/02_cli_guide/profile.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Profile
3+
lang: en-US
4+
---
5+
6+
# The `profile` Command
7+
8+
The `chibi profile` command is used to retrieve your AniList profile. This command requires you to be logged in to access your profile information.
9+
10+
## Usage
11+
```bash
12+
chibi profile [flags]
13+
```
14+
15+
## Flags
16+
17+
### `-h, --help`
18+
Provides help information for the `chibi profile` command. Use this flag to display details about how the command works.
19+
20+
#### Example:
21+
```bash
22+
$ chibi profile --help
23+
```
24+
25+
## Requirements
26+
This command requires you to be logged in to your AniList account. If you are not logged in, the command will prompt you to do so before retrieving your profile information.
27+
28+
## Example Usage
29+
To fetch your AniList profile, use:
30+
```bash
31+
$ chibi profile
32+
```
33+
34+
## Output
35+
The command will display your AniList profile details, including information like your username, anime and manga statistics, and other profile metadata.
36+
37+
Example Output:
38+
```bash
39+
ID : 851923
40+
Name : CosmicPredator
41+
Total Anime : 147
42+
Total Manga : 1
43+
Total Days Watched : 24.21
44+
Total Chapters Read : 4
45+
URL : https://anilist.co/user/851923
46+
```

‎docs/02_cli_guide/search.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: Search
3+
lang: en-US
4+
---
5+
6+
# The `search` Command Documentation
7+
8+
The `chibi search` command allows you to search for anime and manga by providing a query. You can specify the type of media and control the number of results returned.
9+
10+
## Usage
11+
```bash
12+
$ chibi search [query...] [flags]
13+
```
14+
15+
## Flags
16+
17+
### `-h, --help`
18+
Provides help information for the `chibi search` command. Use this flag to display details about how the command works and the options available.
19+
20+
#### Example:
21+
```bash
22+
$ chibi search --help
23+
```
24+
25+
### `-p, --page int`
26+
Specifies the number of results to be returned. By default, the command will return up to 10 results. You can increase or decrease this value to suit your needs.
27+
28+
#### Example:
29+
```bash
30+
$ chibi search "Attack on Titan" --page 5
31+
```
32+
This command will return up to 5 results for the query `"Attack on Titan"`.
33+
34+
### `-t, --type string`
35+
Filters the search results by the type of media. Use the full name or shorthand notation:
36+
37+
- `anime` or `a`: Filters for anime.
38+
- `manga` or `m`: Filters for manga.
39+
40+
If no type is specified, the default type is `anime`.
41+
42+
#### Example:
43+
```bash
44+
$ chibi search "One Piece" --type manga
45+
```
46+
This command will search for manga titled `"One Piece"`.
47+
48+
### Combined Example
49+
You can combine the `--page` and `--type` flags to fine-tune your search results:
50+
51+
```bash
52+
$ chibi search "Naruto" --type anime --page 3
53+
```
54+
This command will return up to 3 anime results for the query `"Naruto"`.
55+
56+
## Defaults
57+
- The default `type` is `anime`.
58+
- The default `page` is 10 results.
59+
60+
### Example of Default Usage
61+
```bash
62+
$ chibi search My Hero Academia
63+
```
64+
This command will search for up to 10 anime results for the query `"My Hero Academia"`.
65+
66+
## Output
67+
The output will display the search results, including the title, score and id of the media.
68+
69+
Example Output:
70+
```bash
71+
┌─────────┬─────────────────────────────────────┬────────┐
72+
│ ID │ TITLE │ SCORE │
73+
├─────────┼─────────────────────────────────────┼────────┤
74+
│ 21459 │ My Hero Academia │ 77.0 │
75+
│ 18289 │ My Hero Academia FINAL SEASON │ 0.00 │
76+
│ 10072 │ My Hero Academia: Two Heroes │ 74.0 │
77+
│ 10427 │ My Hero Academia Season 4 │ 78.0 │
78+
│ 13963 │ My Hero Academia Season 6 │ 82.0 │
79+
│ 11719 │ My Hero Academia Season 5 │ 73.0 │
80+
│ 10016 │ My Hero Academia Season 3 │ 79.0 │
81+
│ 16313 │ My Hero Academia Season 7 │ 81.0 │
82+
│ 21856 │ My Hero Academia Season 2 │ 79.0 │
83+
│ 18573 │ My Hero Academia: Vigilantes │ 00.0 │
84+
└─────────┴─────────────────────────────────────┴────────┘
85+
```

0 commit comments

Comments
 (0)