Torrra

https://torrra.readthedocs.io/en/latest/
Admin
Torrra is a Python CLI tool for finding and downloading torrents with support for indexer services...
Tokens:4,506
Snippets:74
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Torrra using pipx (Recommended)

Source: https://torrra.readthedocs.io/en/latest/installation.html

Use pipx for cross-platform installation to ensure an isolated environment. This method automatically handles the installation of core dependencies like libtorrent.

```bash
pipx install torrra

```

--------------------------------

### Example config.toml Structure

Source: https://torrra.readthedocs.io/en/latest/configuration.html

This snippet shows a comprehensive example of the config.toml file, detailing general settings, indexer configurations, and their respective parameters.

```toml
[general]
download_path = "/home/username/Downloads"    # The default folder where torrents will be saved
download_in_external_client = false           # If true, opens magnet links in an external torrent client instead of downloading the .torrent file.
theme = "textual-dark"                        # Theme for the application (e.g., "textual-dark", "textual-light", etc.).
timeout = 10                                  # The timeout in seconds for requests to indexers.
max_retries = 3                               # The maximum number of times to retry a request to an indexer if it times out.
use_cache = true                              # If true, search results will be cached to speed up subsequent searches.
cache_ttl = 300                               # The time in seconds that search results will be cached.
seed_ratio = 1.5                              # Target upload/download ratio. Seeding stops when reached. Omit or set None for infinite seeding.

[indexers]
default = "jackett"                           # The name of the default indexer to use if none is specified at runtime

[indexers.jackett]
url = "http://localhost:9117"                 # Base URL of the Jackett instance
api_key = "your-jackett-api-key"              # API key for authentication

[indexers.prowlarr]
url = "http://localhost:9696"                 # Base URL of the Prowlarr instance
api_key = "your-prowlarr-api-key"             # API key for authentication

```

--------------------------------

### Set Up Development Environment

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Use 'uv sync' to install all project dependencies and set up the development environment.

```bash
uv sync
```

--------------------------------

### Run Torrra from Development Setup

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Execute the 'torrra' command from your local development setup.

```bash
uv run torrra
```

--------------------------------

### Install Torrra using Homebrew on macOS

Source: https://torrra.readthedocs.io/en/latest/installation.html

Install Torrra on macOS using Homebrew by first tapping the community repository and then installing the package. This installs the precompiled binary version.

```bash
brew tap Maniacsan/homebrew-torrra
brew install torrra

```

--------------------------------

### Install Torrra from AUR (Arch Linux - Binary)

Source: https://torrra.readthedocs.io/en/latest/installation.html

For Arch Linux users, install the precompiled binary package from AUR using yay for a faster installation. This option does not require Python dependencies on your system.

```bash
yay -S torrra-bin

```

--------------------------------

### Set up Torrra Local Development Environment

Source: https://torrra.readthedocs.io/en/latest/installation.html

Clone the Torrra repository and set up a local development environment using uv or pip for contributing or running from source. This installs dependencies and provides a runnable development version.

```bash
git clone https://github.com/stabldev/torrra
cd torrra
uv sync # or `pip install -e .` (if you prefer pip)
uv run torrra

```

--------------------------------

### Install Torrra from AUR (Arch Linux - Source)

Source: https://torrra.readthedocs.io/en/latest/installation.html

For Arch Linux users, install Torrra by compiling from source using an AUR helper like yay. This ensures you have the latest features but may take longer.

```bash
yay -S torrra

```

--------------------------------

### Get a Specific Configuration Value

Source: https://torrra.readthedocs.io/en/latest/usage.html

Retrieves the value associated with a specific configuration key using the 'config get' subcommand.

```bash
torrra config get <key>
```

--------------------------------

### Run Torrra directly using Nix

Source: https://torrra.readthedocs.io/en/latest/installation.html

Execute Torrra directly from its GitHub repository using Nix without a formal installation. This is useful for testing or quick usage.

```bash
nix run github:stabldev/torrra

```

--------------------------------

### Display Torrra Version

Source: https://torrra.readthedocs.io/en/latest/usage.html

Displays the current installed version of the torrra application.

```bash
torrra --version
```

--------------------------------

### Get Configuration Value via CLI

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Retrieve the value of a specific configuration key using the 'torrra config get' command.

```bash
torrra config get general.download_path

```

--------------------------------

### Initialize Torrra with Jackett

Source: https://torrra.readthedocs.io/en/latest/usage.html

Use this command to set up torrra with Jackett as your torrent indexer. Replace the placeholder with your actual Jackett API key.

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

--------------------------------

### List All Configuration Values

Source: https://torrra.readthedocs.io/en/latest/usage.html

Lists all currently set configuration values using the 'config list' subcommand.

```bash
torrra config list
```

--------------------------------

### List All Configuration Values

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Use this command to display all currently set configuration values in your `config.toml` file. It shows general preferences and indexer-related entries.

```bash
torrra config list

```

--------------------------------

### Initialize Torrra with Prowlarr

Source: https://torrra.readthedocs.io/en/latest/usage.html

Use this command to set up torrra with Prowlarr as your torrent indexer. Ensure the "Prefer Magnet URL" option is checked in Prowlarr settings. Replace the placeholder with your actual Prowlarr API key.

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

--------------------------------

### Clone Your Fork

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Clone your forked repository to your local machine and navigate into the project directory.

```bash
git clone https://github.com/YOUR_USERNAME/torrra.git
cd torrra

```

--------------------------------

### Directly Search for Torrents

Source: https://torrra.readthedocs.io/en/latest/usage.html

Bypass the welcome screen and search for torrents directly using the 'search' command. This will immediately display search results.

```bash
torrra search "arch linux iso"
```

--------------------------------

### Display Indexer Command Help

Source: https://torrra.readthedocs.io/en/latest/usage.html

Displays specific help information for the 'jackett' or 'prowlarr' indexer commands.

```bash
torrra jackett --help
torrra prowlarr --help
```

--------------------------------

### Set Theme via CLI

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Use the 'torrra config set' command to change the application theme directly from the command line.

```bash
torrra config set general.theme gruvbox

```

--------------------------------

### Directly Download Torrents

Source: https://torrra.readthedocs.io/en/latest/usage.html

Download torrents directly from a magnet URI or a .torrent file using the 'download' command. The downloads interface will open showing the new torrent.

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

--------------------------------

### Set a Specific Configuration Value

Source: https://torrra.readthedocs.io/en/latest/usage.html

Sets a configuration key to a specified value using the 'config set' subcommand.

```bash
torrra config set <key> <value>
```

--------------------------------

### Quick Docker Usage of Torrra

Source: https://torrra.readthedocs.io/en/latest/installation.html

Run Torrra using its official Docker image for quick usage with a specific indexer without persistent configuration. Replace placeholders with your actual indexer details.

```bash
docker run --rm -it stabldev/torrra:latest jackett --url <url> --api-key <api_key>

```

--------------------------------

### Access Torrra Configuration Subcommands

Source: https://torrra.readthedocs.io/en/latest/usage.html

Use the 'config' subcommand to manage torrra's configuration settings directly from the command line.

```bash
torrra config
```

--------------------------------

### Make Standalone Binary Executable

Source: https://torrra.readthedocs.io/en/latest/installation.html

On Linux and macOS, after downloading a standalone Torrra binary, you must make it executable using chmod. Replace the placeholder filename with the actual downloaded file name.

```bash
chmod +x torrra-vX.Y.Z-*-x86_64

```

--------------------------------

### Commit Changes

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Stage all changes and commit them with a clear and descriptive message. Use 'feat:' prefix for features and 'fix:' for bug fixes, referencing issue numbers.

```bash
git add .
git commit -m "feat: Add new awesome feature"
# or
git commit -m "fix: Resolve issue #123 with download manager"

```

--------------------------------

### Push to Your Fork

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Push your committed changes to your forked repository on the branch you created.

```bash
git push origin feature/your-feature-name

```

--------------------------------

### Docker Usage with Mounted Config and Downloads

Source: https://torrra.readthedocs.io/en/latest/installation.html

Run Torrra via Docker with persistent configuration and downloads by mounting local directories into the container. Ensure your config.toml is correctly set up for persistent downloads.

```bash
docker run --rm -it \
  -v ~/.config/torrra:/root/.config/torrra \
  -v /path/to/your/downloads:/root/Downloads \
  stabldev/torrra:latest jackett --url <url> --api-key <api_key>

```

--------------------------------

### Create a New Branch

Source: https://torrra.readthedocs.io/en/latest/contributing.html

Create a new branch for your feature or bug fix. Use 'feature/' prefix for new features and 'bugfix/' for bug fixes, referencing the issue number.

```bash
git checkout -b feature/your-feature-name # for new features
# or
git checkout -b bugfix/issue-number # for bug fixes

```

--------------------------------

### Run Torrra with Default Indexer

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Execute Torrra without specifying an indexer to use the default indexer configured in config.toml.

```bash
torrra

```

--------------------------------

### Display Torrra Help Message

Source: https://torrra.readthedocs.io/en/latest/usage.html

Shows the general help message for the torrra CLI when no subcommand is provided or when explicitly requested.

```bash
torrra
torrra --help
```

--------------------------------

### Set Theme in config.toml

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Modify the 'theme' setting within the '[general]' section of your config.toml file to change the application's appearance.

```toml
[general]
theme = "gruvbox"

```

--------------------------------

### Run Torrra with Specific Indexer

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Specify an indexer name when running Torrra to use its corresponding configuration from config.toml.

```bash
torrra jackett

```

--------------------------------

### Directly Search for Torrents Without Cache

Source: https://torrra.readthedocs.io/en/latest/usage.html

Perform a direct search for torrents while disabling the opt-in caching feature. This ensures fresh search results.

```bash
torrra search "ubuntu iso" --no-cache
```

--------------------------------

### Add Torrra to NixOS configuration

Source: https://torrra.readthedocs.io/en/latest/installation.html

Integrate Torrra into your NixOS system by adding it to your flake.nix inputs and system packages. This requires Nix flakes to be enabled.

```nix
# In flake.nix inputs:
torrra.url = "github:stabldev/torrra";

# In your NixOS configuration:
environment.systemPackages = [ inputs.torrra.packages.${pkgs.system}.default ];

```

--------------------------------

### Set Configuration Value via CLI

Source: https://torrra.readthedocs.io/en/latest/configuration.html

Modify a configuration setting using the 'torrra config set' command, providing the key and new value.

```bash
torrra config set general.download_in_external_client true

```
Tokens:
Raw