Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/pystardust/ani-cli

A cli tool to browse and play anime
https://github.com/pystardust/ani-cli

anime cli fzf linux mac posix rofi shell steamdeck syncplay terminal termux webscraping windows

Last synced: about 1 month ago
JSON representation

A cli tool to browse and play anime

Lists

README 

        















































A cli to browse and watch anime (alone AND with friends). This tool scrapes the site allanime.



	



	Showcase




[ani-cli-demo.webm](https://user-images.githubusercontent.com/44473782/224679247-0856e652-f187-4865-bbcf-5a8e5cf830da.webm)



## Table of Contents



- [Fixing errors](#fixing-errors)

- [Install](#install)

  - [Tier 1: Linux, Mac, Android](#tier-1-support-linux-mac-android)

  - [Tier 2: Windows, iOS, Steam Deck](#tier-2-support-windows-ios-steam-deck)

  - [From Source](#installing-from-source)

- [Uninstall](#uninstall)

- [Dependencies](#dependencies-1)

  - [Ani-Skip](#ani-skip)

- [Homies](#homies)

- [Contribution Guidelines](./CONTRIBUTING.md)

- [Disclaimer](./disclaimer.md)



## Fixing errors



If you encounter `No results found` (and are sure the prompt was correct) or any breaking issue, then make sure you are on **latest version** by typing

`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run windows terminal preview and there type `ani-cli -U`.

If after this the issue persists then open an issue.



## Install



[![Packaging status](https://repology.org/badge/vertical-allrepos/ani-cli.svg?minversion=4.0)](https://repology.org/project/ani-cli/versions)



### Tier 1 Support: Linux, Mac, Android



*These Platforms have rock solid support and are used by maintainers and large parts of the userbase.*



Linux



#### Native Packages



*Native packages have a more robust update cycle, but sometimes they are slow to upgrade. \

If the one for your platform is up-to-date we suggest going with it.*



Debian 13/unstable



```sh

sudo apt install ani-cli

```



Fedora



To install mpv (and vlc) you need _RPM Fusion free_ enabled. Simply follow the instructions here: https://rpmfusion.org/Configuration

To be able to install syncplay, you'll need to enable this copr repo (instructions included): https://copr.fedorainfracloud.org/coprs/batmanfeynman/syncplay/.



To install ani-cli:

```sh

sudo dnf copr enable derisis13/ani-cli

sudo dnf install ani-cli

```

*If for your distro uses rpm and you would like to see a native package, open an issue.*



Arch



Build and install from the AUR:

```sh

yay -S ani-cli

```

Also consider `ani-cli-git`



Gentoo



Build and install from the GURU:

```sh

sudo eselect repository enable guru

sudo emaint sync -r guru

sudo emerge -a ani-cli

```

Consider using the 9999 ebuild.

```sh

sudo emerge -a =app-misc/ani-cli-9999

```



OpenSuse



On Suse the provided MPV and VLC packages are missing features that are used by ani-cli. The only required is the "Only Essentials" repository which has versions for each Suse release.

You can find instructions on this [here](https://en.opensuse.org/Additional_package_repositories#Packman).



To add the ani-cli copr repo, update then install ani-cli run (on both versions):

```sh

zypper addrepo https://download.copr.fedorainfracloud.org/results/derisis13/ani-cli/opensuse-tumbleweed-x86_64/ ani-cli

zypper dup

zypper install ani-cli

```

You'll get a warning about `Signature verification failed [4-Signatures public key is not available]` but this can be ignored from the prompt.



*Note: package is noarch, so any architecture should work, even though the repo is labelled x86-64*



MacOS



Install dependencies [(See below)](#dependencies-1)



Install [HomeBrew](https://docs.brew.sh/Installation) if not installed.



```sh

git clone "https://github.com/pystardust/ani-cli.git" && cd ./ani-cli

cp ./ani-cli "$(brew --prefix)"/bin

cd .. && rm -rf ./ani-cli

```



*To install (with Homebrew) the dependencies required on Mac OS, you can run:*



```sh

brew install curl grep aria2 ffmpeg git fzf yt-dlp && \

brew install --cask iina

```

*Why iina and not mpv? Drop-in replacement for mpv for MacOS. Integrates well with OSX UI. Excellent support for M1. Open Source.*



Android



Install termux [(Guide)](https://termux.com/)



#### Termux package



```sh

pkg up -y

pkg install ani-cli

```

If you're using Android 14 make sure to run this due to [#1206](https://github.com/pystardust/ani-cli/issues/1206):

```sh

pkg install termux-am

```



For players you can use the apk (playstore/fdroid) versions of mpv and vlc. Note that these cannot be checked from termux so a warning is generated when checking dependencies.



### Tier 2 Support: Windows, iOS, Steam Deck



*While officially supported, installation is more involved on these platforms and sometimes issues arise. \

Reach out if you need help.*



Windows



First, you'll need windows terminal preview. [(Install)](https://apps.microsoft.com/store/detail/windows-terminal-preview/9N8G5RFZ9XK3?hl=en-us&gl=US) It comes preinstalled with Windows 11



Then, install scoop. You will use this to install and update ani-cli from time to time. [(Install)](https://scoop.sh/) Follow **quickstart**.



```sh

scoop bucket add extras

scoop install ani-cli fzf mpv git

```

Consider also installing `yt-dlp` and `aria2` for downloading to work



#### Dependencies



All dependencies can be installed with scoop (from the extras bucket), however some users experienced that installed programs aren't always added to the path. If this happens installing from winget instead usually works.



Note that curl can cause issues.

ani-cli has been tested unsuccessfully with curl `7.83.1` and successfully with `7.86.0`.

If you run into issues, try the scoop install or grab the newest curl you can find.



iOS



Install iSH and VLC from the app store.



Make sure apk is updated using

```apk update; apk upgrade```

then run this:

```sh

apk add grep sed curl fzf git aria2 ncurses

apk add ffmpeg

git clone --depth 1 https://github.com/pystardust/ani-cli ~/.ani-cli

cp ~/.ani-cli/ani-cli /usr/local/bin/ani-cli

chmod +x /usr/local/bin/ani-cli

rm -rf ~/.ani-cli

```

note that downloading is going to be very slow. This is an iSH issue, not an ani-cli issue.



Steam Deck



#### Copypaste script:



* Switch to Desktop mode (`STEAM` Button > Power > Switch to Desktop)

* Open `Konsole` (Steam Deck Icon in bottom left corner > System > Konsole)

* Copy the script, paste it in the CLI and press Enter("A" button on Steam Deck)



```sh

[ ! -d ~/.local/bin ] && mkdir ~/.local/bin && echo "export PATH=$HOME/.local/bin:\$PATH" >> ".$(echo $SHELL | sed -nE "s|.*/(.*)\$|\1|p")rc"



git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf

~/.fzf/install



mkdir ~/.aria2c

curl -o ~/.aria2c/aria2-1.36.0.tar.bz2 https://github.com/q3aql/aria2-static-builds/releases/download/v1.36.0/aria2-1.36.0-linux-gnu-64bit-build1.tar.bz2

tar xvf ~/.aria2c/aria2-1.36.0.tar.bz2 -C ~/.aria2c/

cp ~/.aria2c/aria2-1.36.0-linux-gnu-64bit-build1/aria2c ~/.local/bin/

chmod +x ~/.local/bin/aria2c



curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o ~/.local/bin/yt-dlp

chmod +x ~/.local/bin/yt-dlp



mkdir ~/.patch

curl -o ~/.patch/patch.tar.zst https://mirror.sunred.org/archlinux/core/os/x86_64/patch-2.7.6-10-x86_64.pkg.tar.zst

tar xvf ~/.patch/patch.tar.zst -C ~/.patch/

cp ~/.patch/usr/bin/patch ~/.local/bin/



git clone https://github.com/pystardust/ani-cli.git ~/.ani-cli

cp ~/.ani-cli/ani-cli ~/.local/bin/



flatpak install io.mpv.Mpv

```

press enter("A" button on Steam Deck) on questions



#### Installation in steps:



##### Install mpv (Flatpak version):



```sh

flatpak install io.mpv.Mpv

```

press enter("A" button on Steam Deck) on questions



##### Install [fzf](https://github.com/junegunn/fzf):



```sh

git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf

~/.fzf/install

```

press enter("A" button on Steam Deck) on questions



##### Make a ~/.local/bin folder if doesn't exist and add it to $PATH



```sh

[ ! -d ~/.local/bin ] && mkdir ~/.local/bin && echo "export PATH=$HOME/.local/bin:\$PATH" >> ".$(echo $SHELL | sed -nE "s|.*/(.*)\$|\1|p")rc"

```



##### Install [aria2](https://github.com/aria2/aria2) (needed for download feature only):



```sh

mkdir ~/.aria2c

curl -o ~/.aria2c/aria2-1.36.0.tar.bz2 https://github.com/q3aql/aria2-static-builds/releases/download/v1.36.0/aria2-1.36.0-linux-gnu-64bit-build1.tar.bz2

tar xvf ~/.aria2c/aria2-1.36.0.tar.bz2 -C ~/.aria2c/

cp ~/.aria2c/aria2-1.36.0-linux-gnu-64bit-build1/aria2c ~/.local/bin/

chmod +x ~/.local/bin/aria2c

```



##### Install [yt-dlp](https://github.com/yt-dlp/yt-dlp) (needed for download feature only):



```sh

curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o ~/.local/bin/yt-dlp

chmod +x ~/.local/bin/yt-dlp

```



##### Install [patch](https://savannah.gnu.org/projects/patch/) (needed for self-update feature [ -U ] ):



```sh

mkdir ~/.patch

curl -o ~/.patch/patch.tar.zst https://mirror.sunred.org/archlinux/core/os/x86_64/patch-2.7.6-10-x86_64.pkg.tar.zst

tar xvf ~/.patch/patch.tar.zst -C ~/.patch/

cp ~/.patch/usr/bin/patch ~/.local/bin/

```



##### Install ani-cli:



```sh

git clone https://github.com/pystardust/ani-cli.git ~/.ani-cli

cp ~/.ani-cli/ani-cli ~/.local/bin/

```



##### Optional: add desktop entry:



```

echo '[Desktop Entry]

Encoding=UTF-8

Type=Application

Exec=bash -c "source $HOME/.'$(echo $SHELL | sed -nE "s|.*/(.*)\$|\1|p")'rc && konsole --fullscreen -e ani-cli"

Name=ani-cli' > $HOME/.local/share/applications/ani-cli.desktop

```

The .desktop entry will allow to start ani-cli in Konsole directly from "Gaming Mode"

In Steam Desktop app:

`Add game` > `Add a non-steam game` > tick a box for `ani-cli` > `Add selected programs`



### Installing from source



*This method works for any unix-like operating system and is a baseline for porting efforts.*



Install dependencies [(See below)](#dependencies-1)



```sh

git clone "https://github.com/pystardust/ani-cli.git"

sudo cp ani-cli/ani-cli /usr/local/bin

rm -rf ani-cli

```



## Uninstall



* apt:

```sh

sudo apt remove ani-cli

# to remove the repository from apt

sudo rm -f /etc/apt/trusted.gpg.d/ani-cli.asc /etc/apt/sources.list.d/ani-cli-debian.list

```

* dnf:

```sh

sudo dnf remove ani-cli      # for ani-cli

# disable the repo in dnf

dnf copr disable derisis13/ani-cli

```

You might want to uninstall RPM fusion if you don't use it otherwise

* zypper:

```sh

zypper remove ani-cli

zypper removerepo ani-cli

```

You might want to remove `packman-essentials` if you don't need it otherwise

* AUR:

```sh

yay -R ani-cli

```

* Scoop:

```sh

scoop uninstall ani-cli

```

* Linux:

```sh

sudo rm "/usr/local/bin/ani-cli"

```

* Mac:

```sh

rm "$(brew --prefix)/bin/ani-cli"

```

* Windows:

In **Git Bash** run (as administrator):

```sh

rm "/usr/bin/ani-cli"

```

* Termux package

```sh

pkg remove ani-cli

```

* Android:

```sh

rm "$PREFIX/bin/ani-cli"

```

* Steam Deck

```sh

rm "~/.local/bin/ani-cli"

rm -rf ~/.ani-cli

```

optionally: remove dependencies:

```sh

rm ~/.local/bin/aria2c

rm ~/.local/bin/yt-dlp

rm -rf "~/.aria2"

rm -rf "~/.fzf"

flatpak uninstall io.mpv.Mpv

```

* iOS

```

rm -rf /usr/local/bin/ani-cli

```

To uninstall other dependencies:

```

apk del grep sed curl fzf git aria2 ffmpeg ncurses

```



## Dependencies



- grep

- sed

- curl

- mpv - Video Player

- iina - mpv replacement for MacOS

- aria2c - Download manager

- yt-dlp - m3u8 Downloader

- ffmpeg - m3u8 Downloader (fallback)

- fzf - User interface

- ani-skip (optional)

- patch - Self updating



### Ani-Skip



Ani-skip is a script to automatically skip anime opening sequences, making it easier to watch your favorite shows without having to manually skip the intros each time (from the original [README](https://github.com/synacktraa/ani-skip/tree/master#a-script-to-automatically-skip-anime-opening-sequences-making-it-easier-to-watch-your-favorite-shows-without-having-to-manually-skip-the-intros-each-time)).



For install instructions visit [ani-skip](https://github.com/synacktraa/ani-skip).



Ani-skip uses the external lua script function of mpv and as such – for now – only works with mpv.



**Warning:** For now, ani-skip does **not** seem to work under Windows.



**Note:** It may be, that ani-skip won't know the anime you're trying to watch. Try using the `--skip-title ` command line argument. (It uses the [aniskip API](https://github.com/lexesjan/typescript-aniskip-extension/tree/main/src/api/aniskip-http-client) and you can contribute missing anime or ask for including it in the database on their [discord server](https://discord.com/invite/UqT55CbrbE)).



## Homies



* [animdl](https://github.com/justfoolingaround/animdl): Ridiculously efficient, fast and light-weight (supports most sources: allanime, zoro ... (Python)

* [jerry](https://github.com/justchokingaround/jerry): stream anime with anilist tracking and syncing, with discord presence (Shell)

* [anipy-cli](https://github.com/sdaqo/anipy-cli): ani-cli rewritten in python (Python)

* [Dantotsu](https://github.com/rebelonion/Dantotsu): Rebirth of Saikou, Best android app for anime/manga/LN with anilist integration (Kotlin)

* [mangal](https://github.com/metafates/mangal): Download & read manga from any source with anilist sync (Go)

* [lobster](https://github.com/justchokingaround/lobster): Watch movies and series from the terminal (Shell)

* [mov-cli](https://github.com/mov-cli/mov-cli): Watch everything from your terminal. (Python)

* [dra-cla](https://github.com/CoolnsX/dra-cla): ani-cli equivalent for korean dramas (Shell)

* [redqu](https://github.com/port19x/redqu):  A media centric reddit client (Clojure)

* [doccli](https://github.com/TowarzyszFatCat/doccli):  A cli to watch anime with POLISH subtitles (Python)

* [GoAnime](https://github.com/alvarorichard/GoAnime): A CLI tool to browse, play, and download anime in Portuguese(Go)