@laxman1892/anime-cli
v0.1.1
Published
Cross-platform anime CLI for search, streaming, and downloads.
Maintainers
Readme
anime-cli
Cross-platform anime CLI for searching shows, choosing episodes, streaming in local players, and downloading with external tools.
Features
- Search anime from SubsPlease
- Browse episodes and available qualities
- Stream through
mpvorvlc - Download with
aria2c,yt-dlp, orwebtorrent - Save preferences such as player, downloader, quality, and download path
- Check external tool availability with
anime-cli doctor
Requirements
- Node.js 20 or newer
- npm
Optional external tools:
mpvfor playbackvlcfor playbackwebtorrentfor magnet streaming and torrent downloadsaria2cfor direct downloadsyt-dlpfor direct downloads
The CLI detects these automatically and tells you what is available.
Install
From npm
npm install -g @laxman1892/anime-cliThen run:
anime-cli doctor
anime-cliRun without global install
npx @laxman1892/anime-cli doctor
npx @laxman1892/anime-cliFrom source
npm install
npm run build
node bin/anime.js doctor
node bin/anime.jsExternal Tools Setup
You only need the tools you plan to use.
Windows
Install any of these and make sure they are available on PATH:
mpvvlcwebtorrent-cliaria2yt-dlp
After installing them, open a new terminal and run:
anime-cli doctormacOS
With Homebrew, a typical setup looks like:
brew install mpv vlc webtorrent-cli aria2 yt-dlpThen verify:
anime-cli doctorLinux
Install the tools from your distro package manager where available, then run:
anime-cli doctorUsage
Start the interactive flow:
anime-cliOr search directly:
anime-cli search "Frieren"Useful commands:
anime-cli doctor
anime-cli config list
anime-cli config get preferredPlayer
anime-cli config set preferredPlayer mpv
anime-cli config set preferredDownloader webtorrent
anime-cli config set preferredQuality 1080p
anime-cli config set downloadPath C:\animeConfiguration
Stored settings currently include:
- preferred player
- preferred downloader
- preferred quality
- download path
Use:
anime-cli config listto inspect current values.
Publishing To npm
Before publishing:
- Make sure you are logged in to npm.
- Run the full test suite.
- Build the package.
- Bump the version in
package.json.
Commands:
npm login
npm test
npm publishThis package uses:
filesinpackage.jsonto publish only the runtime package contentsprepublishOnlyto run the test suite before publishingpublishConfig.access=publicfor public npm publication
Package Contents
Published package contents are limited to:
bin/dist/README.mdLICENSE
Development
npm install
npm run devChecks:
npm run check
npm testNotes
- Playback of magnet links uses WebTorrent plus a local player such as
mpvorvlc. - Direct playback depends on the provider returning a playable source.
License
MIT
