Skip to content

Commit 4faa1c8

Browse files
port19xDerisis13CoolnsXjustchokingaround71zenith
committed
docs: readme update
+ docs: remove old deps and add syntax to code blocks + docs: acknowledging history disappearence + docs: missing fzf in brew installation + docs: windows instructions for v4 + docs: termux instructions for v4 Co-authored-by: port19 <port19@port19.xyz> Co-authored-by: Derisis13 <email.felhasznalasra@gmail.com> Co-authored-by: CoolnsX <ansari.tan20@gmail.com> Co-authored-by: chokerman <44473782+justchokingaround@users.noreply.github.com> Co-authored-by: zenith71 <71zenith@protonmail.com>
1 parent f9ee701 commit 4faa1c8

1 file changed

Lines changed: 51 additions & 58 deletions

File tree

README.md

Lines changed: 51 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
<h1 align="center">
1010
<a href="https://matrix.to/#/#ani-cli:matrix.org"><img src="https://element.io/blog/content/images/2020/07/Logomark---white-on-green.png" width="80"></a>
1111
<a href="https://discord.gg/aqu7GpqVmR"><img src="https://pnggrid.com/wp-content/uploads/2021/05/Discord-Logo-Square-1024x1024.png" width="80"></a>
12-
<a href="https://nightly.revolt.chat/invite/4FKHbs78"><img src="https://developers.revolt.chat/img/logo.png" width="80"></a>
1312
<br>
1413
<a href="https://github.com/port19x"><img src="https://img.shields.io/badge/lead-port19x-lightblue"></a>
1514
<a href="https://github.com/CoolnsX"><img src="https://img.shields.io/badge/maintainer-CoolnsX-blue"></a>
@@ -20,7 +19,7 @@
2019
</p>
2120

2221
<h3 align="center">
23-
A cli to browse and watch anime (alone AND with friends). This tool scrapes the site <a href="https://animixplay.to/">animixplay.</a>
22+
A cli to browse and watch anime (alone AND with friends). This tool scrapes the site <a href="https://allanime.site/">allanime.</a>
2423
</h3>
2524

2625
<h1 align="center">
@@ -32,7 +31,7 @@ https://user-images.githubusercontent.com/44473782/160729779-41fe207c-b5aa-4fed-
3231
## Table of Contents
3332

3433
- [Fixing errors](#Fixing-errors)
35-
- [New in v3](#New-in-v3)
34+
- [New in v4](#New-in-v4)
3635
- [Install](#Install)
3736
- [Linux](#Linux)
3837
- [Debian](#Debian)
@@ -43,7 +42,7 @@ https://user-images.githubusercontent.com/44473782/160729779-41fe207c-b5aa-4fed-
4342
- [MacOS](#MacOS)
4443
- [Windows](#Windows)
4544
- [Android](#Android)
46-
- [Steam Deck](#steam-deck)
45+
- [Steam Deck](#Steam-deck)
4746
- [Uninstall](#Uninstall)
4847
- [Dependencies](#Dependencies)
4948
- [Homies](#Homies)
@@ -56,22 +55,30 @@ If you encounter "Video url not found" or any breaking issue, then make sure you
5655
`sudo ani-cli -U` to update on Linux, Mac and Android. On Windows, run gitbash as administrator then there type `ani-cli -U`.
5756
If after this the issue persists then open an issue.
5857

58+
History has been reworked and relocated. We're working on a transition script, please be patient. Old history can be viewed with `less ${XDG_CACHE_HOME:-$HOME/.cache}/ani-hsts`
59+
60+
## New in v4
61+
62+
V4 was a complete rewrite, which is why it took so long.
63+
64+
The user interface is now powered by [fzf](https://github.com/junegunn/fzf), tho it may be changed to [gum](https://github.com/charmbracelet/gum) in an upcoming version.
65+
5966
## Install
6067

6168
#### Users of V3.2 or the v3.2.x series should uninstall before upgrading
6269
Otherwise you're likely to see an error like the following: ` "/usr/bin/ani-cli: line 470: (...)/player_mpv: No such file or directory"`
6370

6471
### Native packages
6572

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

6875
*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.*
6976

7077
### Linux
7178

7279
#### Debian
7380

74-
```
81+
```sh
7582
wget -qO- https://Wiener234.github.io/ani-cli-ppa/KEY.gpg | sudo tee /etc/apt/trusted.gpg.d/ani-cli.asc
7683
wget -qO- https://Wiener234.github.io/ani-cli-ppa/ani-cli-debian.list | sudo tee /etc/apt/sources.list.d/ani-cli-debian.list
7784
sudo apt update
@@ -96,7 +103,7 @@ Build and install from the AUR:
96103
```sh
97104
yay -S ani-cli
98105
```
99-
Also consider ani-cli-git
106+
Also consider `ani-cli-git`
100107

101108
#### OpenSuse Tumbleweed and Leap
102109

@@ -111,20 +118,18 @@ zypper install ani-cli
111118
```
112119
You'll get a warning about `Signature verification failed [4-Signatures public key is not available]` but this can be ignored from the prompt.
113120

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

116123
#### Installing from source
117124

118125
Install dependencies [(See below)](#Dependencies)
119126

120127
```sh
121128
sudo rm -rf "/usr/local/share/ani-cli" "/usr/local/bin/ani-cli" "/usr/local/bin/UI" /usr/local/bin/player_* #If some of these aren't found, it's not a problem
122-
git clone "https://github.com/pystardust/ani-cli.git" && cd ./ani-cli
123-
sudo cp ./ani-cli /usr/local/bin
124-
cd .. && rm -rf "./ani-cli"
129+
git clone "https://github.com/pystardust/ani-cli.git"
130+
sudo cp ani-cli/ani-cli /usr/local/bin
131+
rm -rf ani-cli
125132
```
126-
*Also note that mpv installed through flatpak is not compatible*
127-
128133

129134
### MacOS
130135

@@ -142,21 +147,20 @@ cd .. && rm -rf ./ani-cli
142147
*To install (with Homebrew) the dependencies required on Mac OS, you can run:*
143148

144149
```sh
145-
brew install curl grep axel openssl@1.1 ffmpeg git && \
150+
brew install wget grep aria2 ffmpeg git fzf && \
146151
brew install --cask iina
147152
```
148153
*Why iina and not mpv? Drop-in replacement for mpv for MacOS. Integrates well with OSX UI. Excellent support for M1. Open Source.*
149154

150155
### Windows
151156

152-
*Make sure git bash is installed [(Install)](https://git-scm.com/download/win)*
157+
*ani-cli needs a posix shell and the current way is git bash. Unfortunately fzf can't run in git bash's default terminal. The solution is to use git bash in windows terminal*
153158

154-
*Note that the installation instruction below must be done inside **Git Bash**, not in Command Prompt or Powershell*
159+
First, you'll need windows terminal preview. [(Install)](https://apps.microsoft.com/store/detail/windows-terminal-preview/9N8G5RFZ9XK3?hl=de-at&gl=at&rtc=1)
155160

156-
mpv is not added to $PATH automatically when installed and thus the script is unable to use it. You either have to do this manually, or install it via scoop (recommended):
157-
```sh
158-
scoop install mpv
159-
```
161+
Then make sure git bash is installed. [(Install)](https://git-scm.com/download/win) It needs to be added to windows terminal [(Instructions)](https://stackoverflow.com/questions/56839307/adding-git-bash-to-the-new-windows-terminal)
162+
163+
The following steps and ani-cli need to be run from git bash in windows terminal.
160164

161165
#### Scoop bucket
162166

@@ -168,12 +172,14 @@ scoop install ani-cli
168172
#### From source
169173
```sh
170174
rm -rf "/usr/local/share/ani-cli" "/usr/local/bin/ani-cli" "/usr/local/bin/UI" /usr/local/bin/player_* #If some of these aren't found, it's not a problem
171-
git clone "https://github.com/pystardust/ani-cli.git" && cd ./ani-cli
172-
cp ./ani-cli /usr/bin
173-
cd .. && rm -rf ./ani-cli
175+
git clone "https://github.com/pystardust/ani-cli.git"
176+
cp ani-cli/ani-cli /usr/bin
177+
rm -rf /ani-cli
174178
```
175179

176-
*Run ani-cli in Git Bash (Running it in cmd or powershell may or may not work)*
180+
#### Dependencies
181+
182+
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.
177183

178184
### Android
179185

@@ -191,18 +197,12 @@ pkg install ani-cli
191197
```sh
192198
pkg up -y
193199
rm -rf "$PREFIX/share/ani-cli" "$PREFIX/bin/ani-cli" "$PREFIX/bin/UI" "$PREFIX"/local/bin/player_* #If some of these aren't found, it's not a problem
194-
git clone "https://github.com/pystardust/ani-cli.git" && cd ./ani-cli
195-
cp ./ani-cli "$PREFIX"/bin
196-
cd .. && rm -rf ./ani-cli
200+
git clone "https://github.com/pystardust/ani-cli.git"
201+
cp ani-cli/ani-cli "$PREFIX"/bin
202+
rm -rf /ani-cli
197203
```
198204

199-
Note : Vlc Android now works too ;)
200-
201-
You need to add any referrer in mpv by opening mpv [(playstore version)](https://play.google.com/store/apps/details?id=is.xyz.mpv), going into Settings -> Advanced -> Edit mpv.conf and adding (for example):
202-
203-
```
204-
referrer="https://animixplay.to/"
205-
```
205+
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.
206206

207207
### Steam Deck
208208

@@ -212,7 +212,7 @@ referrer="https://animixplay.to/"
212212
* Open `Konsole` (Steam Deck Icon in bottom left corner > System > Konsole)
213213
* Copy the script, paste it in the CLI and press Enter("A" button on Steam Deck)
214214

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

218218
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
@@ -225,9 +225,7 @@ cp ~/.aria2c/aria2-1.36.0-linux-gnu-64bit-build1/aria2c ~/.local/bin/
225225
chmod +x ~/.local/bin/aria2c
226226

227227
git clone https://github.com/pystardust/ani-cli.git ~/.ani-cli
228-
cd ~/.ani-cli && git checkout v4 && cd
229228
cp ~/.ani-cli/ani-cli ~/.local/bin/
230-
chmod +x ~/.local/bin/ani-cli
231229

232230
flatpak install io.mpv.Mpv
233231
```
@@ -237,28 +235,28 @@ press enter("A" button on Steam Deck) on questions
237235

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

240-
```
238+
```sh
241239
flatpak install io.mpv.Mpv
242240
```
243241
press enter("A" button on Steam Deck) on questions
244242

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

247-
```
245+
```sh
248246
git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
249247
~/.fzf/install
250248
```
251249
press enter("A" button on Steam Deck) on questions
252250

253-
##### Make a ~/.local/bin folder if doesnt exist and add it to $PATH
251+
##### Make a ~/.local/bin folder if doesn't exist and add it to $PATH
254252

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

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

261-
```
259+
```sh
262260
mkdir ~/.aria2c
263261
wget -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
264262
tar xvf ~/.aria2c/aria2-1.36.0.tar.bz2 -C ~/.aria2c/
@@ -268,11 +266,9 @@ chmod +x ~/.local/bin/aria2c
268266

269267
##### Install ani-cli:
270268

271-
```
269+
```sh
272270
git clone https://github.com/pystardust/ani-cli.git ~/.ani-cli
273-
cd ~/.ani-cli && git checkout v4 && cd -
274271
cp ~/.ani-cli/ani-cli ~/.local/bin/
275-
chmod +x ~/.local/bin/ani-cli
276272
```
277273

278274
##### Optional: add desktop entry:
@@ -294,13 +290,13 @@ In Steam Desktop app:
294290
## Uninstall
295291

296292
* apt:
297-
```
293+
```sh
298294
sudo apt remove ani-cli
299-
# to remove the repository from apt:
295+
# to remove the repository from apt
300296
sudo rm -f /etc/apt/trusted.gpg.d/ani-cli.asc /etc/apt/sources.list.d/ani-cli-debian.list
301297
```
302298
* dnf:
303-
```
299+
```sh
304300
sudo dnf remove ani-cli # for ani-cli
305301
# disable the repo in dnf
306302
dnf copr disable derisis13/ani-cli
@@ -313,7 +309,7 @@ zypper removerepo ani-cli
313309
```
314310
You might want to remove `packman-essentials` if you don't need it otherwise
315311
* AUR:
316-
```
312+
```sh
317313
yay -R ani-cli
318314
```
319315
* Scoop:
@@ -334,20 +330,20 @@ In **Git Bash** run (as administrator):
334330
rm "/usr/bin/ani-cli"
335331
```
336332
* Termux package
337-
```
333+
```sh
338334
pkg remove ani-cli
339335
```
340336
* Android:
341337
```sh
342338
rm "$PREFIX/bin/ani-cli"
343339
```
344340
* Steam Deck
345-
```
341+
```sh
346342
rm "~/.local/bin/ani-cli"
347343
rm -rf ~/.ani-cli
348344
```
349345
optionally: remove dependencies:
350-
```
346+
```sh
351347
rm ~/.local/bin/aria2c
352348
rm -rf "~/.aria2"
353349
rm -rf "~/.fzf"
@@ -358,20 +354,17 @@ flatpak uninstall io.mpv.Mpv
358354

359355
- grep
360356
- sed
361-
- awk
362-
- curl
363357
- wget
364-
- openssl
365358
- mpv - Video Player
366359
- iina - mpv replacement for MacOS
367360
- aria2c - Download manager
368361
- ffmpeg - m3u8 Downloader
369362
- fzf - User interface
370363

364+
## Homies
371365

372-
## Homies
373-
374-
* [animdl](https://github.com/justfoolingaround/animdl): Ridiculously efficient, fast and light-weight (supports most sources: animixplay, 9anime...) (Python)
366+
* [animdl](https://github.com/justfoolingaround/animdl): Ridiculously efficient, fast and light-weight (supports most sources: allanime, zoro ... (Python)
367+
* [jerry](https://github.com/justchokingaround/jerry): stream anime with anilist tracking and syncing, with discord presence (Shell)
375368
* [anime-helper-shell](https://github.com/Atreyagaurav/anime-helper-shell): A python shell for searching, watching, and downloading anime (Python)
376369
* [anipy-cli](https://github.com/sdaqo/anipy-cli): ani-cli rewritten in python (Python)
377370
* [dra-cla](https://github.com/CoolnsX/dra-cla): ani-cli equivalent for korean dramas (Shell)

0 commit comments

Comments
 (0)