crunchy-cli

A Go written cli client for crunchyroll. To use it, you need a crunchyroll premium account for full access & features.

CLI 🖥️ • Disclaimer ☝️ • License ⚖

This repo was former known as crunchyroll-go (which still exists but now contains only the library part) but got split up into two separate repositories to provide more flexibility.

This tool relies on the crunchyroll-go library to communicate with crunchyroll. The library enters maintenance mode (only small fixes, no new features) with version v3 in favor of rewriting it completely in Rust. crunchy-cli follows it (with version v2.3.0) and won't have major updates until the Rust rewrite of the library reaches a good usable state.

🖥️ CLI

✨ Features

• Download single videos and entire series from crunchyroll.
• Archive episode or seasons in an .mkv file with multiple subtitles and audios and compress them to gzip or zip files.
• Specify a range which episodes to download from an anime.

💾 Get the executable

• 📥 Download the latest binaries here or get it from below:
  • Linux (x64)
  • Windows (x64)
  • MacOS (x64)
• If you use Arch btw. or any other Linux distro which is based on Arch Linux, you can download the package via the AUR:

  $ yay -S crunchy-cli
  

• On Windows scoop can be used to install it (added by @AdmnJ):

  $ scoop bucket add extras # <- in case you haven't added the extra repository already
  $ scoop install crunchyroll-go
  

• 🛠 Build it yourself. Must be done if your target platform is not covered by the provided binaries (like Raspberry Pi or M1 Mac):
  • use make (requires go to be installed):

  $ git clone https://github.com/crunchy-labs/crunchy-cli
  $ cd crunchy-cli
  $ make
  $ sudo make install # <- only if you want to install it on your system
  

  • use go:

  $ git clone https://github.com/crunchy-labs/crunchy-cli
  $ cd crunchy-cli
  $ go build -o crunchy .
  

📝 Examples

Before reading: Because of the huge functionality not all cases can be covered in the README. Make sure to check the wiki, further usages and options are described there.

Login

Before you can do something, you have to log in first.

This can be performed via crunchyroll account email and password.

$ crunchy login [email protected] password

or via refresh token / etp_rt cookie

$ crunchy login --refresh-token 7578ce50-5712-3gef-b97e-01332d6b588c

Download

By default, the cli tries to download the episode with your system language as audio. If no streams with your system language are available, the video will be downloaded with japanese audio and hardsubbed subtitles in your system language. If your system language is not supported, an error message will be displayed and en-US (american english) will be chosen as language.

$ crunchy download https://beta.crunchyroll.com/watch/GRDKJZ81Y/alone-and-lonesome

With -r best the video(s) will have the best available resolution (mostly 1920x1080 / Full HD).

$ crunchy download -r best https://beta.crunchyroll.com/watch/GRDKJZ81Y/alone-and-lonesome

The file is by default saved as a .ts (mpeg transport stream) file. .ts files may can't be played or are looking very weird (it depends on the video player you are using). With the -o flag, you can change the name (and file ending) of the output file. So if you want to save it as, for example, mp4 file, just name it whatever.mp4. You need ffmpeg to store the video in other file formats.

$ crunchy download -o "daaaaaaaaaaaaaaaarling.ts" https://beta.crunchyroll.com/watch/GRDKJZ81Y/alone-and-lonesome

With the --audio flag you can specify which audio the video should have and with --subtitle which subtitle it should have. Type crunchy help download to see all available locales.

$ crunchy download --audio ja-JP --subtitle de-DE https://beta.crunchyroll.com/series/GY8VEQ95Y/darling-in-the-franxx

Flags

The following flags can be (optional) passed to modify the download process.

Archive

Archive works just like download. It downloads the given videos as .mkv files and stores all (soft) subtitles in it. Default audio locales are japanese and your system language (if available) but you can set more or less with the --language flag.

Archive a file

$ crunchy archive https://beta.crunchyroll.com/watch/GRDKJZ81Y/alone-and-lonesome

Downloads the first two episode of Darling in the FranXX and stores it compressed in a file.

$ crunchy archive -c "ditf.tar.gz" https://beta.crunchyroll.com/series/GY8VEQ95Y/darling-in-the-franxx

Flags

The following flags can be (optional) passed to modify the archive process.

Info

The info displays some information about the account which is used for the cli.

$ crunchy info

Update

If you want to update your local version of crunchy-cli, this command makes this easier. It checks if a new version is available and if so, updates itself.

$ crunchy update

Global flags

These flags you can use across every sub-command:

☝️ Disclaimer

This tool is ONLY meant to be used for private purposes. To use this tool you need crunchyroll premium anyway, so there is no reason why rip and share the episodes.

The responsibility for what happens to the downloaded videos lies entirely with the user who downloaded them.

⚖ License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0) - see the LICENSE file for more details.