This commit is contained in:
Nikola Kubiczek 2022-01-16 23:12:43 +01:00
parent 0b25e074e3
commit 7d87d656d1
Signed by: yaemiku
GPG Key ID: ADC039636B3E4AAB

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# nyaa
cli tool for downloading torrents from [nyaa.si](https://nyaa.si), heavily inspired by [notflix](https://github.com/Bugswriter/notflix)
## Dependencies
* [pmenu](https://github.com/sgtpep/pmenu) - Dynamic terminal-based menu
* [webtorrent](https://github.com/webtorrent/webtorrent-cli) - Tool to download torrents
* [aria2](https://aria2.github.io/) - Lightweight alternative for webtorrent
## Usage
```sh
$ nyaa
$ nyaa -q "XYZ" # Search for XYZ (otherwise show search prompt)
$ nyaa -d some-dir # Download to somedir, defaults to $HOME/Downloads
$ nyaa -a # Show remakes as well
```
## Installation
```sh
$ sudo curl -sL "https://raw.githubusercontent.com/yaemiku/nyaa/main/nyaa" -o /usr/local/bin/nyaa
$ sudo chmod +x /usr/local/bin/nyaa
```
## License
This project is licensed under the GNU General Public License, version 3.