https://github.com/loiccoyle/rofi-prowlet

🔎 Rofi wrapper for prowlet. Use the Prowlarr search API to find torrents.
https://github.com/loiccoyle/rofi-prowlet

prowlarr prowlet rofi rofi-scripts search shell-script torrent

Last synced: 12 days ago
JSON representation

🔎 Rofi wrapper for prowlet. Use the Prowlarr search API to find torrents.

• Host: GitHub
• URL: https://github.com/loiccoyle/rofi-prowlet
• Owner: loiccoyle
• License: mit
• Created: 2022-12-28T16:31:17.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T19:15:32.000Z (8 months ago)
• Last Synced: 2025-03-31T04:26:13.161Z (about 2 months ago)
• Topics: prowlarr, prowlet, rofi, rofi-scripts, search, shell-script, torrent
• Language: Shell
• Homepage:
• Size: 22.5 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rofi-prowlet





[`rofi`](https://github.com/davatorium/rofi) wrapper for [`prowlet`](https://github.com/loiccoyle/prowlet), a cli utility to query `Prowlarr`.

> Use the [`Prowlarr`](https://github.com/prowlarr/prowlarr) search API to find torrents.

![rofi-prowlet](https://i.imgur.com/RudooO4.png)

## 📦 Installation

### Dependencies

- [`rofi`](https://github.com/davatorium/rofi)

- [`prowlet`](https://github.com/loiccoyle/prowlet)

- [`jq`](https://github.com/stedolan/jq)

Optional:

- [webtorrent](https://github.com/webtorrent/webtorrent): for torrent streaming.

You'll need to have `Prowlarr` running locally or have access to a `Prowlarr` server.

### Manual

You'll need to git clone this repository and place the script somewhere in your `$PATH`.

```console

git clone https://github.com/loiccoyle/rofi-prowlet

cd rofi-prowlet

cp rofi-prowlet /somewhere/in/your/PATH/

```

### Arch linux

Using your prefered AUR helper:

```console

paru -S rofi-prowlet-git

```

## 📋 Usage

`rofi-prowlet` is just wrapping [`prowlet`](https://github.com/loiccoyle/prowlet), any options will be passed on to `prowlet`.

```console

$ rofi-prowlet -h

Use "-" to read the json Prowlarr response from stdin e.g.:

$ prowlet search big buck bunny | rofi-prowlet -

Otherwise, rofi-prowlet passes any provided options to the prowlet command:

Query the Prowlarr search API from the command line.

Usage:

    prowlet [OPTIONS] {search, config, indexers, categories, open}

        -h                        Show this message and exit.

        -r                        Raw output, no coloring.

        -v                        Verbosisty, up to -vv.

        -s                        Start prowlarr.service if not running.

        -k                        Stop prowlarr.service before exiting.

        -u PROWLARR_URL           Prowlarr URL.

        -a API_KEY                Prowlarr API key, will query prowlarr if not provided.

```

## 🥳 Contributing

Please feel free to open a PR, especially to add common torrent related actions.