FastAnime

^{Browse anime from the terminal}

• FastAnime
  • Installation
    • Installation using your favourite package manager
      • Using uv
      • Using pipx
      • Using pip
    • Installing the bleeding edge version
    • Building from the source
    • External Dependencies
  • Usage
    • The Commandline interface 🔥
      • The anilist command 🔥 🔥 🔥
        • Running without any subcommand
        • Subcommands
      • download subcommand
      • search subcommand
      • grab subcommand
      • downloads subcommand
      • config subcommand
      • cache subcommand
      • update subcommand
      • completions subcommand
      • fastanime serve
    • MPV specific commands
      • Key Bindings
      • Script Messages
  • styling the default interface
  • Configuration
  • Contributing
  • Receiving Support
  • Supporting the Project

Installation

The app can run wherever python can run. So all you need to have is python installed on your device. On android you can use termux. If you have any difficulty consult for help on the discord channel

Installation on nixos

nix profile install github:Benex254/fastanime

Installation using your favourite package manager

Currently the app is only published on pypi. With the following extras available:

• standard -which installs all dependencies
• api - which installs dependencies required to use fastanime serve
• mpv - which installs python mpv
• notifications - which installs plyer required for desktop notifications

Using uv

Recommended method of installation is using uv.

# generally:
uv tool install "fastanime[standard]"

# or stripped down installations:
uv tool install fastanime
uv tool install "fastanime[api]"
uv tool install "fastanime[mpv]"
uv tool install "fastanime[notifications]"

Using pipx

pipx install fastanime
# -- or for the development version --
pipx install 'fastanime==.dev1'
# example
# pipx install 'fastanime==0.60.1.dev1'

Using pip

pip install fastanime
# -- or for the development version --
pip install 'fastanime==.dev1'
# example
# pip install 'fastanime==0.60.1.dev1'

Installing the bleeding edge version

To install the latest build which are created on every push by GitHub actions, download the fastanime_debug_build of your choosing from the GitHub actions page. Then:

unzip fastanime_debug_build

# outputs fastanime.tar.gz

pipx install fastanime.tar.gz

# --- or ---

pip install fastanime.tar.gz

Building from the source

Requirements:

• git
• python 3.10 and above
• uv

To build from the source, follow these steps:

1. Clone the repository: git clone https://github.com/FastAnime/FastAnime.git --depth 1
2. Navigate into the folder: cd FastAnime
3. Then build and Install the app:

# build and install fastanime with uv
uv tool install .

4. Enjoy! Verify installation with:

fastanime --version

> [!Tip] > > Download the completions from here for your shell. > To add completions: > > - Fish Users: cp $FASTANIME_PATH/completions/fastanime.fish ~/.config/fish/completions/ > - Bash Users: Add source $FASTANIME_PATH/completions/fastanime.bash to your .bashrc > - Zsh Users: Add source $FASTANIME_PATH/completions/fastanime.zsh to your .zshrc > or using the built in command fastanime completions

External Dependencies

The only required external dependency, unless you won't be streaming, is MPV, which i recommend installing with uosc 🔥 and thumbfast for the best experience since they add a better interface to it.

> [!NOTE] > > The project currently sees no reason to support any other video > player because we believe nothing beats MPV and it provides > everything you could ever need with a small footprint. > But if you have a reason feel free to encourage as to do so. > However, on android this is not the case so vlc is also supported

Other external dependencies that will just make your experience better:

• webtorrent-cli used when the provider is nyaa
• ffmpeg is required to be in your path environment variables to properly download hls streams.
• fzf 🔥 which is used as a better alternative to the ui.
• rofi 🔥 which is used as another alternative ui + the desktop entry ui
• chafa currently the best cross platform and cross terminal image viewer for the terminal.
• icat an image viewer that only works in kitty terminal, which is currently the best terminal in my opinion, and by far the best image renderer for the terminal thanks to kitty's terminal graphics protocol. Its terminal graphics is so op that you can run a browser on it!!
• bash is used as the preview script language.
• ani-skip used for skipping the opening and ending theme songs
• ffmpegthumbnailer used for local previews of downloaded anime
• syncplay to enable watch together.
• feh used in manga mode

Usage

The project offers a featureful command-line interface and MPV interface through the use of python-mpv. The project also offers subs in different languages thanks to hianime provider.

The Commandline interface 🔥

Designed for efficiency and automation. Plus has a beautiful pseudo-TUI in some of the commands. If you are stuck anywhere just use --help before the command you would like to get help on

Overview of main commands:

• fastanime anilist: Powerful command for browsing and exploring anime due to AniList integration.
• fastanime download: Download anime.
• fastanime search: Powerful command meant for binging since it doesn't require the interfaces
• fastanime downloads: View downloaded anime and watch with MPV.
• fastanime config: Quickly edit configuration settings.
• fastanime cache: Quickly manage the cache fastanime uses
• fastanime update: Quickly update fastanime
• fastanime grab: print streams to stdout to use in non python application.

Overview of options

Most options are directly passed into fastanime directly and are shared by multiple subcommands.

Most of the options override your config file.

This is a convention to make the dev time faster since it reduces redundancy and also makes switching of subcommands with the same options easier to the end user.

In general fastanime --

Available options for the fastanime include:

• --server or -s set the default server to auto select
• --continue/--no-continue or -c/-no-c whether to continue from the last episode you were watching
• --local-history/--remote-history whether to use remote or local history defaults to local
• --quality <1080/720/480/360> or -q <1080/720/480/360> the link to choose from server
• --translation-type or -t what language for anime
• --dub dubbed anime
• --sub subbed anime
• --auto-select/--no-auto-select or -a/-no-a auto select title from provider results
• --auto-next/--no-auto-next or -A/-no-A auto select next episode
• `-downloads-dir