https://github.com/loiccoyle/rofi-cuff
🔎 Rofi wrapper for cuff. Use the Jackett search API to find torrents.
https://github.com/loiccoyle/rofi-cuff
cuff jackett rofi rofi-scripts torrent
Last synced: 20 days ago
JSON representation
🔎 Rofi wrapper for cuff. Use the Jackett search API to find torrents.
- Host: GitHub
- URL: https://github.com/loiccoyle/rofi-cuff
- Owner: loiccoyle
- License: mit
- Created: 2021-04-16T23:48:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T14:38:06.000Z (over 2 years ago)
- Last Synced: 2025-04-05T13:51:24.001Z (about 1 month ago)
- Topics: cuff, jackett, rofi, rofi-scripts, torrent
- Language: Shell
- Homepage:
- Size: 67.4 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rofi-cuff
[`rofi`](https://github.com/davatorium/rofi) wrapper for [`cuff`](https://github.com/loiccoyle/cuff). Use the [`Jackett`](https://github.com/jackett/jackett) search API to find torrents.
[See it in action](https://imgur.com/7roVMqQ)
**Do you use [`Prowlarr`](https://github.com/prowlarr/prowlarr) instead of `Jackett`? Check out [`prowlet`](https://github.com/loiccoyle/prowlet) / [`rofi-prowlet`](https://github.com/loiccoyle/rofi-prowlet)**
# Installation
### Dependencies
* [`rofi`](https://github.com/davatorium/rofi)
* [`cuff`](https://github.com/loiccoyle/cuff)
* [`jq`](https://github.com/stedolan/jq)
Optional:
* [webtorrent](https://github.com/webtorrent/webtorrent): for torrent streaming.
Of course you'll also need access to a `Jackett` server.
### Manual
You'll need to git clone this repository and place the script somewhere in your `$PATH`.
```
git clone https://github.com/loiccoyle/rofi-cuff
cd rofi-cuff
cp rofi-cuff /somewhere/in/your/PATH/
```
### Arch linux
Using your prefered AUR helper:
```
paru -S rofi-cuff-git
```
# Usage
`rofi-cuff` is just wrapping [`cuff`](https://github.com/loiccoyle/cuff), any options will be passed on to `cuff`.
```
$ rofi-cuff -h
Use "-" to read the json Jackett response from stdin e.g.:
$ cuff search big buck bunny | rofi-cuff -
Otherwise, rofi-cuff passes any provided options to the main cuff command:
Query the Jackett search API from the command line.
Usage:
cuff [OPTIONS] {search, config, indexers, categories, open}
-h Show this message and exit.
-r Raw output, no coloring.
-v Verbosisty, up to -vv.
-s Start Jackett service if not running.
-k Stop Jackett service before exiting.
-u JACKETT_URL Jackett URL.
-a API_KEY Jackett API key, will query Jackett if not provided.
-p PASSWORD Jackett password.
```
# Contributing
Please feel free to open a PR, especially to add common torrent related actions.