Usage¶

torrra provides a streamlined command-line interface for your torrent needs, allowing you to search for, download, and manage torrents directly from your terminal.

To get started, you need to specify an indexer (like Jackett or Prowlarr) and provide its connection details.

Initializing with an Indexer¶

Using Jackett¶

To use Jackett as your torrent indexer, provide its URL and API key:

torrra jackett --url http://localhost:9117 --api-key <your_jackett_api_key>

Replace <your_jackett_api_key> with your actual Jackett API key.

Using Prowlarr¶

Similarly, to use Prowlarr as your torrent indexer:

torrra prowlarr --url http://localhost:9696 --api-key <your_prowlarr_api_key>

Replace <your_prowlarr_api_key> with your actual Prowlarr API key. Note: When using Prowlarr, ensure the "Prefer Magnet URL" option is checked in your Prowlarr settings for optimal compatibility.

Direct Search¶

You can bypass the initial welcome screen and search for torrents directly from your command line using the search command:

torrra search "arch linux iso"

This command will immediately display the search results for the given query.

The search command also supports the --no-cache option:

torrra search "ubuntu iso" --no-cache

Direct Download¶

You can download torrents directly from magnet URIs or .torrent files without searching using the download command:

torrra download "magnet:?xt=urn:btih:..."
# or torrra download "/path/to/file.torrent"

This command will immediately start the download and open the downloads interface showing the new torrent.

Command-Line Interface (CLI)¶

torrra offers a comprehensive CLI for managing configurations and launching the application with specific indexers.

Command	Description
`torrra`	Displays the help message if no subcommand is provided
`torrra --help`	Shows the general help message
`torrra --version`	Displays the current installed version of `torrra`
`torrra search <query>`	Searches for a torrent directly from the command line, bypassing the welcome screen.
`torrra download <magnet_uri_or_file>`	Downloads a torrent directly from a magnet URI or .torrent file.
`torrra config`	Accesses the configuration subcommands (see below)
`torrra jackett`	Initializes `torrra` using `Jackett` as the torrent indexer
`torrra prowlarr`	Initializes `torrra` using `Prowlarr` as the torrent indexer

`torrra config` Subcommands¶

These subcommands allow you to manage torrra’s configuration directly from the command line.

Subcommand	Description
`torrra config get <key>`	Retrieves the value associated with a specific configuration key
`torrra config set <key> <value>`	Sets a configuration key to a specified value
`torrra config list`	Lists all currently set configuration values

Indexer Options¶

Both the jackett and prowlarr commands support the following options:

--url (Required): The base URL of your Jackett or Prowlarr instance.
--api-key (Required): Your API key for authentication with the indexer.
--no-cache: Disables the opt-in caching feature for searches.
--help: Displays specific help for the indexer command.

Text-User Interface (TUI) Controls¶

Once torrra is running (after specifying an indexer), you’ll interact with it through its intuitive Text-User Interface (TUI). Here are the primary keyboard controls for navigation and interaction:

Key	Action
`↑` / `k`	Navigate up through the list of search results
`↓` / `j`	Navigate down through the list of search results
`Enter` / `l`	Initiate the download for the currently selected torrent
`ctrl+u`	Page up in the results list
`ctrl+d`	Page down in the results list
`ctrl+t`	Open the theme switcher to change the application’s appearance
`G`	Scroll to the bottom of the results list
`gg`	Scroll to the top of the results list (press `g` twice)
`Tab`	Move focus to the next interactive widget (e.g., search box, results list)
`p`	Pause the currently active download
`r`	Resume a previously paused download
`q`	Quit `torrra` and exit the application