NyxErinys/crunchy-cli
1
0
Fork 0
mirror of https://github.com/crunchy-labs/crunchy-cli.git synced 2026-01-21 04:02:00 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
bytedream 2023-06-16 10:14:36 +02:00
parent 4123c4912a
commit a8727a164a
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -141,9 +141,9 @@ With the session stored, you do not need to use `--credentials` / `--etp-rt` any
Define an output template by using the `-o` / `--output` flag.
If you want to use any other file format than [`.ts`](https://en.wikipedia.org/wiki/MPEG_transport_stream) you need [ffmpeg](https://ffmpeg.org/).
```shell
$ crunchy download -o "ditf.ts" https://www.crunchyroll.com/watch/GRDQPM1ZY/alone-and-lonesome
$ crunchy download -o "ditf.mp4" https://www.crunchyroll.com/watch/GRDQPM1ZY/alone-and-lonesome
```
Default is `{title}.ts` or `{title}.mp4`, depending on the version of binary you're using. See the Template Options section below for more options.
Default is `{title}.mp4`. See the [Template Options section](#output-template-options) below for more options.
- Resolution
@ -187,7 +187,7 @@ With the session stored, you do not need to use `--credentials` / `--etp-rt` any
```shell
$ crunchy archive -o "{title}.mkv" https://www.crunchyroll.com/series/GY8VEQ95Y/darling-in-the-franxx
```
Default is `{title}.mkv`. See the Template Options section below for more options.
Default is `{title}.mkv`. See the [Template Options section](#output-template-options) below for more options.
- Resolution
@ -222,22 +222,22 @@ With the session stored, you do not need to use `--credentials` / `--etp-rt` any
You can use various template options to change how the filename is processed. The following tags are available:
- {title} → Title of the video
- {series_name} → Name of the series
- {season_name} → Name of the season
- {audio} → Audio language of the video
- {resolution} → Resolution of the video
- {season_number} → Number of the season
- {episode_number} → Number of the episode
- {relative_episode_number} → Number of the episode relative to its season
- {series_id} → ID of the series
- {season_id} → ID of the season
- {episode_id} → ID of the episode
- `{title}` → Title of the video
- `{series_name}` → Name of the series
- `{season_name}` → Name of the season
- `{audio}` → Audio language of the video
- `{resolution}` → Resolution of the video
- `{season_number}` → Number of the season
- `{episode_number}` → Number of the episode
- `{relative_episode_number}` → Number of the episode relative to its season
- `{series_id}` → ID of the series
- `{season_id}` → ID of the season
- `{episode_id}` → ID of the episode
When including a file extension in the output, use the `.mp4` extension when using a binary crunchy-cli v3.0.0-dev.9 or newer and using the `download` option. `.mkv` is the default file extension for `archive` downloads. Here is an example of using output templates:
Example:
```shell
$ crunchy archive -o "[S{season_number}E{episode_number}] {title}.mkv" https://www.crunchyroll.com/series/G8DHV7W21/dragon-ball
# Outputs: '[S01E01] Secret of the Dragon Ball.mkv'
# Output file: '[S01E01] Secret of the Dragon Ball.mkv'
```
### Episode filtering