Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Beastwick18/nyaa
A tui tool for browsing and downloading torrents
https://github.com/Beastwick18/nyaa
anime cli nyaa nyaa-magnet-links nyaa-rss nyaa-si nyaasi ratatui rust rust-lang terminal-user-interface torrent torrent-downloader torrent-management torrent-search torrent-search-engine tui
Last synced: 2 days ago
JSON representation
A tui tool for browsing and downloading torrents
- Host: GitHub
- URL: https://github.com/Beastwick18/nyaa
- Owner: Beastwick18
- License: gpl-3.0
- Created: 2022-08-09T13:39:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T19:13:34.000Z (13 days ago)
- Last Synced: 2024-11-05T04:42:14.177Z (4 days ago)
- Topics: anime, cli, nyaa, nyaa-magnet-links, nyaa-rss, nyaa-si, nyaasi, ratatui, rust, rust-lang, terminal-user-interface, torrent, torrent-downloader, torrent-management, torrent-search, torrent-search-engine, tui
- Language: Rust
- Homepage: https://crates.io/crates/nyaa
- Size: 46.4 MB
- Stars: 407
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - nyaa - A nyaa.si tui tool for browsing and downloading torrents. (💻 Apps / 🌌 Other)
README
nyaa 🐈⬛
A simple TUI for browsing and downloading anime torrents from nyaa.si.
)
## Table of Contents
- [Installation](#-installation)
- [With a package manager](#with-a-package-manager)
- [Nix (via home-manager)](#nix-via-home-manager)
- [Windows/Linux Binaries](#windowslinux-binaries)
- [From Source](#from-source)
- [Wiki](#-wiki)
- [Keybinds](#%EF%B8%8F-keybinds)
- [Proxies](#-proxies)
- [Configuration](#%EF%B8%8F-configuration)
- [Download Client Integration](#download-client-integration)
- [Clipboard](#-clipboard)
- [Custom Themes](#-custom-themes)
- [Planned Features](#%EF%B8%8F-planned-features)
## ⚡ Installation
### With a package manager
```sh
### With cargo
cargo install nyaa
### On Arch Linux (AUR)
yay -S nyaa # or `nyaa-bin` for a pre-compiled binary
### Ubuntu/Debian (.deb file from latest release)
# with `apt`:
sudo apt install ./nyaa-VERSION-x86_64.deb
# or `dpkg`:
sudo dpkg -i ./nyaa-VERSION-x86_64.deb
### Fedora (.rpm file from latest release)
sudo dnf install ./nyaa-VERSION-x86_64.rpm
### With `nix profile`
nix profile install github:Beastwick18/nyaa
### nix (flakes) run without installing
nix run github:Beastwick18/nyaa
```
### Nix (via home-manager)
Add to `inputs` in `flake.nix`
```nix
nyaa = {
url = "github:Beastwick18/nyaa";
inputs.nixpkgs.follows = "nixpkgs";
};
```
Add to `home.nix` imports and enable
```nix
imports = [
inputs.nyaa.homeManagerModule
]
programs.nyaa.enable = true;
```
Check the [wiki](https://github.com/Beastwick18/nyaa/wiki/Home%E2%80%90manager) for more information
### Windows/Linux Binaries
Binaries for Linux and Windows are available on the [releases](https://github.com/Beastwick18/nyaa/releases/latest) page.
### From Source
To install from source, you must have `git`, `cargo`, and Rust version $\ge$ 1.75 installed.
```sh
git clone https://github.com/Beastwick18/nyaa
cd nyaa
cargo install --path .
```
## 📗 Wiki
For detailed information on configuration, themes, sources, and download client integration check the [Wiki](https://github.com/Beastwick18/nyaa/wiki).
## ⌨️ Keybinds
Like modal text editors such as Vim, there are several modes. Each have their own keybinds, which can be found out by pressing `F1` or `?` while in that mode. Some of the important ones are:
- hjkl or arrow keys for general navigation
- / or i to search
- Ctrl-s to change sources
- d to change download client
- c to change category
- s to change sort (S for reverse sort)
- f to change filter
- t to change theme
- n, p or l, h for next and previous page
- q to quit
For a list of all modes and their respective keybinds, check [Keybinds](https://github.com/Beastwick18/nyaa/wiki/Keybinds) on the wiki.
## 🌐 Proxies
If either `nyaa.si` or `torrentgalaxy` is not accessible in your region, try one of the proxies ([nyaa proxies](https://nyaatorrents.info/#proxy), [TorrentGalaxy proxies](https://torrends.to/proxy/torrentgalaxy)). Once you find one that works, replace the value for `base_url` in the source config with the working proxy url. For `nyaa`, I would recommend `nyaa.land`, as it is very compatible, and usually working. Here's what the config for `nyaa.land` would look like:
```toml
[source.nyaa]
base_url = 'nyaa.land'
```
If you have your own proxy setup, you use it by adding:
```toml
request_proxy = "localhost:8118"
```
to the top of your config. Replace the value with the IP and port for your proxy.
## ⚙️ Configuration
The location of the config file for linux is:
```
~/.config/nyaa/config.toml
```
and on windows is
```
C:\Users\%USERNAME%\AppData\Roaming\nyaa\config\config.toml
```
### Default Config
```toml
theme = "Default" # the theme to use by default
default_source = "Nyaa" # the source to use by default
download_client = "qBittorrent" # the download client to use by default
date_format = "%Y-%m-%d %H:%M" # date format for results (unset by default)
request_proxy = "localhost:8118" # request proxy for sending requests through (unset by default)
timeout = 30 # request timeout for sources and clients (measured in seconds)
scroll_padding = 6 # scroll padding for results table
save_config_on_change = true # save config when changing sources/themes
[source.nyaa]
# ...
[source.torrentgalaxy]
# ...
[client.cmd]
# ...
# ...
```
`theme` refers to the theme selected by default when the app is opened. Possible values are `Default`, `Dracula`, `Gruvbox`, or `Catppuccin Macchiato`. You can also use custom [user-defined themes](https://github.com/Beastwick18/nyaa/wiki/User%E2%80%90defined-Themes).
`default_source` refers to the source selected by default once the app is opened. Possible values are `Nyaa`, `TorrentGalaxy`, or `Sukebei`. Each source has its own configuration. Check the [wiki](https://github.com/Beastwick18/nyaa/wiki#sources) for more information on each sources config.
`download_client` refers to the download client selected by default once the app is opened. Each download client has its own configuration. Check the [wiki](https://github.com/Beastwick18/nyaa/wiki#download-clients) for more information on each download clients config.
### Download Client Integration
- Check the wiki for connecting to your torrent client:
- [qBittorrent](https://github.com/Beastwick18/nyaa/wiki/qBittorrent)
- [Transmission](https://github.com/Beastwick18/nyaa/wiki/Transmission)
- [rqbit](https://github.com/Beastwick18/nyaa/wiki/rqbit)
- [Download to folder](https://github.com/Beastwick18/nyaa/wiki/Download-to-folder)
- [Open with default app](https://github.com/Beastwick18/nyaa/wiki/Open-with-default-app)
- [Run command](https://github.com/Beastwick18/nyaa/wiki/Run-command)
# 📋 Clipboard
By default, nyaa uses [OSC52](https://www.reddit.com/r/vim/comments/k1ydpn/a_guide_on_how_to_copy_text_from_anywhere/) to copy to the clipboard. It's a type of ANSI escape sequence supported by *most* terminals. The state of support for some popular terminals are:
| Terminal | OSC52 support |
|----------|:-------------:|
| [alacritty](https://github.com/alacritty/alacritty) | **yes** |
| [contour](https://github.com/contour-terminal/contour) | **yes** |
| [far2l](https://github.com/elfmz/far2l) | **yes** |
| [foot](https://codeberg.org/dnkl/foot) | **yes** |
| [gnome terminal](https://github.com/GNOME/gnome-terminal) (and other VTE-based terminals) | [not yet](https://gitlab.gnome.org/GNOME/vte/-/issues/2495) |
| [hterm](https://chromium.googlesource.com/apps/libapps/+/master/README.md) | [**yes**](https://chromium.googlesource.com/apps/libapps/+/master/nassh/doc/FAQ.md#Is-OSC-52-aka-clipboard-operations_supported) |
| [iterm2](https://iterm2.com/) | **yes** |
| [kitty](https://github.com/kovidgoyal/kitty) | **yes** |
| [konsole](https://konsole.kde.org/) | [not yet](https://bugs.kde.org/show_bug.cgi?id=372116) |
| [qterminal](https://github.com/lxqt/qterminal#readme) | [not yet](https://github.com/lxqt/qterminal/issues/839)
| [rxvt](http://rxvt.sourceforge.net/) | **yes** |
| [st](https://st.suckless.org/) | **yes** (but needs to be enabled, see [here](https://git.suckless.org/st/commit/a2a704492b9f4d2408d180f7aeeacf4c789a1d67.html)) |
| [terminal.app](https://en.wikipedia.org/wiki/Terminal_(macOS)) | no, but see [workaround](https://github.com/roy2220/osc52pty) |
| [tmux](https://github.com/tmux/tmux) | **yes** |
| [urxvt](http://software.schmorp.de/pkg/rxvt-unicode.html) | **yes** (with a script, see [here](https://github.com/ojroques/vim-oscyank/issues/4)) |
| [wezterm](https://github.com/wez/wezterm) | [**yes**](https://wezfurlong.org/wezterm/escape-sequences.html#operating-system-command-sequences) |
| [windows terminal](https://github.com/microsoft/terminal) | **yes** |
| [xterm.js](https://xtermjs.org/) (Hyper terminal) | **yes** |
| [zellij](https://github.com/zellij-org/zellij/) | **yes** |
Source: [vim-oscyank](https://github.com/ojroques/vim-oscyank)
If your terminal is not supported, you should disable OSC52 by adding
```toml
[clipboard]
osc52 = false
```
to your `config.toml`. This will make nyaa use an alternative method for copying, such as X11 selections or wl-clipboard. To see more info on clipboards, check the [wiki](https://github.com/Beastwick18/nyaa/wiki/Clipboard-Configuration);
# 🎨 Custom Themes
Check the wiki for how to add [User-defined Themes](https://github.com/Beastwick18/nyaa/wiki/User%E2%80%90defined-Themes)
## 🗺️ Planned Features
- [ ] Mouse support
- [ ] Custom user-defined sources
- [x] ~~Sources other than nyaa~~
- [x] ~~User-defined themes~~
- [x] ~~Integration with torrent clients~~
- [x] ~~RPM Release~~
- [x] ~~Nyaa proxies/mirrors support~~
- [x] ~~Page navigation~~
- [x] ~~Choice between HTML scraper or RSS feed~~