fastanime 2.2.5

A browser anime site experience from the terminal

FastAnime

Welcome to FastAnime, anime site experience from the terminal.

fzf mode

fa_fzf_demo.webm

other modes:

rofi mode

fa_rofi_mode.webm

Default mode

fa_default_mode.webm

Heavily inspired by animdl, magic-tape and ani-cli.

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

[!IMPORTANT]

This project currently scrapes allanime and animepahe. The site is in the public domain and can be accessed by any one with a browser.

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 using your favourite package manager

Currently the app is only published on pypi.

Using pipx

Preferred method of installation since Pipx creates an isolated environment for each app it installs.

pipx install fastanime
# -- or for the development version --
pipx install 'fastanime==<latest-pre-release-tag>.dev1'
# example
# pipx install 'fastanime==0.60.1.dev1'

Using pip

pip install fastanime
# -- or for the development version --
pip install 'fastanime==<latest-pre-release-tag>.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<version>.tar.gz

pipx install fastanime<version>.tar.gz

# --- or ---

pip install fastanime<version>.tar.gz

Building from the source

Requirements:

• git
• python 3.10 and above
• poetry

To build from the source, follow these steps:

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

# Normal Installation
poetry build
cd dist
pip install fastanime<version>.whl

# Editable installation (easiest for updates)
# just do a git pull in the Project dir
# the latter will require rebuilding the app
pip install -e .

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

External Dependencies

The only required external dependency, unless you won't be streaming, is MPV, which i recommend installing with uosc :fire: 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.

Other external dependencies that will just make your experience better:

• 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 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.

Usage

The project offers a featureful command-line interface and MPV interface through the use of python-mpv.

The Commandline interface :fire:

Designed for efficiency and automation. Plus has a beautiful pseudo-TUI in some of the commands.

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 --<option-name>

Available options for the fastanime include:

• --server <server> or -s <server> 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 <dub/sub> or -t <dub/sub> 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 <path> or -d <path> set the folder to download anime into
• --fzf use fzf for the ui
• --default use the default ui
• --preview show a preview when using fzf
• --no-preview dont show a preview when using fzf
• --format <yt-dlp format string> or -f <yt-dlp format string> set the format of anime downloaded and streamed based on yt-dlp format. Works when --server gogoanime
• --icons/--no-icons toggle the visibility of the icons
• --skip/--no-skip whether to skip the opening and ending theme songs.
• --rofi use rofi for the ui
• --rofi-theme <path> theme to use with rofi
• --rofi-theme-input <path> theme to use with rofi input
• --rofi-theme-confirm <path> theme to use with rofi confirm
• --log allow logging to stdout
• --log-file allow logging to a file
• --rich-traceback allow rich traceback
• --use-mpv-mod/--use-default-player whether to use python-mpv
• --provider <allanime/animepahe> anime site of choice to scrape from
• --sync-play or -sp use syncplay for streaming anime so you can watch with your friends

Example usage of the above options

# example of syncplay intergration
fastanime --sync-play --server sharepoint search -t <anime-title>

# --- or ---

# to watch with anilist intergration
fastanime --sync-play --server sharepoint anilist

# downloading dubbed anime
fastanime --dub download <anime>

# use  icons and fzf for a more elegant ui with preview
fastanime --icons --preview --fzf anilist

# use icons with default ui
fastanime --icons --default anilist

The anilist command :fire: :fire: :fire:

Stream, browse, and discover anime efficiently from the terminal using the AniList API.

Running without any subcommand

Run fastanime anilist to access the main interface.

Subcommands

The subcommands are mainly their as convenience. Since all the features already exist in the main interface.

• fastanime anilist trending: Top 15 trending anime.
• fastanime anilist recent: Top 15 recently updated anime.
• fastanime anilist search: Search for anime (top 50 results).
• fastanime anilist upcoming: Top 15 upcoming anime.
• fastanime anilist popular: Top 15 popular anime.
• fastanime anilist favourites: Top 15 favorite anime.
• fastanime anilist random: get random anime

The following are commands you can only run if you are signed in to your AniList account:

• fastanime anilist watching
• fastanime anilist planning
• fastanime anilist rewatching
• fastanime anilist dropped
• fastanime anilist paused
• fastanime anilist completed

Plus: fastanime anilist notifier :fire:

# basic form
fastanime anilist notifier

# with logging to stdout
fastanime --log anilist notifier

# with logging to a file. stored in the same place as your config
fastanime --log-file anilist notifier

The above commands will start a loop that checks every 2 minutes if any of the anime in your watch list that are airing has just released a new episode.

The notification will consist of a cover image of the anime in none windows systems.

You can place the command among your machines startup scripts.

For fish users for example you can decide to put this in your ~/.config/fish/config.fish:

if ! ps aux | grep -q '[f]astanime .* notifier'
  echo initializing fastanime anilist notifier
  nohup fastanime --log-file anilist notifier>/dev/null &
end

[!NOTE] To sign in just run fastanime anilist login and follow the instructions. To view your login status fastanime anilist login --status To erase login data fastanime anilist login --erase

download subcommand

Download anime to watch later dub or sub with this one command. Its optimized for scripting due to fuzzy matching; basically you don't have to manually select search results.

So every step of the way has been and can be automated. Uses a list slicing syntax similar to that of python as the value for the -r option.

[!NOTE]

The download feature is powered by yt-dlp so all the bells and whistles that it provides are readily available in the project. Like continuing from where you left of while downloading, after lets say you lost your internet connection.

Syntax:

# Download all available episodes
# multiple titles can be specified with -t option
fastanime download -t <anime-title> -t <anime-title>
# -- or --
fastanime download -t <anime-title> -t <anime-title> -r ':'

# download latest episode for the two anime titles
# the number can be any no of latest episodes but a minus sign
# must be present
fastanime download -t <anime-title> -t <anime-title> -r '-1'

# latest 5
fastanime download -t <anime-title> -t <anime-title> -r '-5'

# Download specific episode range
# be sure to observe the range Syntax
fastanime download -t <anime-title> -r '<episodes-start>:<episodes-end>:<step>'

fastanime download -t <anime-title> -r '<episodes-start>:<episodes-end>'

fastanime download -t <anime-title> -r '<episodes-start>:'

fastanime download -t <anime-title> -r ':<episodes-end>'

# download specific episode
# remember python indexing starts at 0
fastanime download -t <anime-title> -r '<episode-1>:<episode>'

search subcommand

Powerful command mainly aimed at binging anime. Since it doesn't require interaction with the interfaces.

Uses a list slicing syntax similar to that of python as the value of the -r option.

Syntax:

# basic form where you will still be prompted for the episode number
# multiple titles can be specified with the -t option
fastanime search -t <anime-title> -t <anime-title>

# binge all episodes with this command
fastanime search -t <anime-title> -r ':'

# watch latest episode
fastanime search -t <anime-title> -r '-1'

# binge a specific episode range with this command
# be sure to observe the range Syntax
fastanime search -t <anime-title> -r '<start>:<stop>'

fastanime search -t <anime-title> -r '<start>:<stop>:<step>'

fastanime search -t <anime-title> -r '<start>:'

fastanime search -t <anime-title> -r ':<end>'

grab subcommand

Helper command to print streams to stdout so it can be used by non-python applications.

The format of the printed out data is json and can be either an array or object depending on how many anime titles have been specified in the command-line or through a subprocess.

[!TIP] For python applications just use its python api, for even greater and easier control. So just add fastanime as one of your dependencies.

Uses a list slicing syntax similar to that of python as the value of the -r option.

Syntax:

# --- print anime info + episode streams ---

# multiple titles can be specified with the -t option
fastanime grab -t <anime-title> -t <anime-title>

# -- or --

# print all available episodes
fastanime grab -t <anime-title> -r ':'

# print the latest episode
fastanime grab -t <anime-title> -r '-1'

# print a specific episode range
# be sure to observe the range Syntax
fastanime grab -t <anime-title> -r '<start>:<stop>'

fastanime grab -t <anime-title> -r '<start>:<stop>:<step>'

fastanime grab -t <anime-title> -r '<start>:'

fastanime grab -t <anime-title> -r ':<end>'

# --- grab options ---

# print search results only
fastanime grab -t <anime-title> -r <range> --search-results-only

# print anime info only
fastanime grab -t <anime-title> -r <range> --anime-info-only

# print episode streams only
fastanime grab -t <anime-title> -r <range> --episode-streams-only

downloads subcommand

View and stream the anime you downloaded using MPV.

Syntax:

fastanime downloads

# view individual episodes
fastanime downloads --view-episodes
# --- or ---
fastanime downloads -v

# to set seek time when using ffmpegthumbnailer for local previews
# -1 means random and is the default
fastanime downloads --time-to-seek <intRange(-1,100)>
# --- or ---
fastanime downloads -t <intRange(-1,100)>

# to get the path to the downloads folder set
fastanime downloads --path
# useful when you want to use the value for other programs

config subcommand

Edit FastAnime configuration settings using your preferred editor (based on $EDITOR environment variable so be sure to set it).

Syntax:

fastanime config

# to get config path which is useful if you want to use it for another program.
fastanime config --path

# add a desktop entry
fastanime config --desktop-entry

# view current contents of your configuration or can be used to get an example config
fastanime config --view

[!Note]

If it opens vim you can exit by typing :q .

cache subcommand

Easily manage the data fastanime has cached; for the previews.

Syntax:

# delete everything in the cache dir
fastanime cache --clean

# print the path to the cache dir and exit
fastanime cache --path

# print the current size of the cache dir and exit
fastanime cache --size

# open the cache dir and exit
fastanime cache

update subcommand

Easily update fastanime to latest

Syntax:

# update fastanime to latest
fastanime update

# check for latest release
fastanime update --check

completions subcommand

Helper command to setup shell completions

Syntax:

# try to detect your shell and print completions
fastanime completions
# print fish completions
fastanime completions --fish
# print bash completions
fastanime completions --bash
# print zsh completions
fastanime completions --zsh

MPV specific commands

The project now allows on the fly media controls directly from mpv. This means you can go to the next or previous episode without the window ever closing thus offering a seamless experience. This is all powered with python-mpv which enables writing mpv scripts with python just like how it would be done in lua.

Key Bindings

<shift>+n fetch the next episode

<shift>+p fetch the previous episode

<shift>+t toggle the translation type from dub to sub

<shift>+a toggle auto next episode

<shit>+r reload episode

Script Messages

Commands issued in the MPV console.

Examples:

# to select episode from mpv without window closing
script-message select-episode <episode-number>

# to select server from mpv without window closing
script-message select-server <server-name>

# to select quality
script-message select-quality <1080/720/480/360>

Configuration

The app includes sensible defaults but can be customized extensively. Configuration is stored in .ini format at ~/.config/FastAnime/config.ini on arch linux; for the other operating systems you can check by running fastanime config --path.

[stream]
continue_from_history = True  # Auto continue from watch history

# which history to use [local/remote]
preferred_history = local

# force mpv window
# passed directly to mpv so values are same
force_window = immediate

translation_type = sub  # Preferred language for anime (options: dub, sub)

server = top  # Default server (options: dropbox, sharepoint, wetransfer.gogoanime, top, wixmp)

auto_next = False  # Auto-select next episode

# Auto select the anime provider results with fuzzy find.
# Note this wont always be correct.But 99% of the time will be.
auto_select=True

# whether to skip the opening and ending theme songs
# note requires ani-skip to be in path
skip=false

# the maximum delta time in minutes after which the episode should be considered as completed
# used in the continue from time stamp
error=3

use_mpv_mod=False

# the format of downloaded anime and trailer
# based on yt-dlp format and passed directly to it
# learn more by looking it up on their site
# only works for downloaded anime if server=gogoanime
# since its the only one that offers different formats
# the others tend not to
format=best[height<=1080]/bestvideo[height<=1080]+bestaudio/best # default

[general]
# can be [allanime,animepahe]
provider = allanime

preferred_language = romaji  # Display language (options: english, romaji)

downloads_dir = <Default-videos-dir>/FastAnime  # Download directory

preview=false # whether to show a preview window when using fzf or rofi

use_fzf=False # whether to use fzf as the interface for the anilist command and others.

use_rofi=false # whether to use rofi for the ui

rofi_theme=<path-to-rofi-theme-file>

rofi_theme_input=<path-to-rofi-theme-file>

rofi_theme_confirm=<path-to-rofi-theme-file>


# whether to show the icons
icons=false

# the duration in minutes a notification will stay in the screen
# used by notifier command
notification_duration=2

[anilist]
# Not implemented yet

The python api

The project offers a python api that can be used in other python programs.

from fastanime.AnimeProvider import AnimeProvider

# all output is typed, so will be easy to work with

# providers include [allanime, animepahe]
provider = AnimeProvider(provider="allanime")

# to search for anime
provider.search_for_anime()

# to get anime info
provider.get_anime()

# to get streams of an episode
provider.get_episode_streams()

Contributing

We welcome your issues and feature requests. However, due to time constraints, we currently do not plan to add another provider.

If you wish to contribute directly, please first open an issue describing your proposed changes so it can be discussed or if you are in a rush for the feature to be merged just open a pr.

Receiving Support

For inquiries, join our Discord Server.

Supporting the Project

Show your support by starring our GitHub repository or buying us a coffee.