Torrra

https://github.com/stabldev/torrra
Admin
A Python tool that lets you search and download torrents without leaving your CLI, powered by...
Tokens:4,816
Snippets:81
Trust Score:9.4
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Set Up Development Environment

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

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

```bash
uv sync
```

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

### Install torrra from AUR binary package using yay

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Install the precompiled binary package of torrra from AUR using yay for a faster installation. This method does not require Python dependencies.

```bash
yay -S torrra-bin
```

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

### Install torrra using pipx (Recommended)

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Use pipx to install torrra in an isolated environment. This method is recommended for most users on Linux, macOS, and Windows.

```bash
pipx install torrra
```

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

### Install torrra from AUR using yay

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Install torrra from the Arch User Repository (AUR) by building from source using yay. This may take longer but provides the latest features.

```bash
yay -S torrra
```

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

### Example torrra config.toml

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

This TOML file demonstrates various configuration options for general settings, default indexers, and specific indexer configurations like Jackett and Prowlarr.

```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

```

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

### Install Torrra using pipx

Source: https://github.com/stabldev/torrra/blob/main/README.md

Install the Torrra CLI tool using pipx. Alternatively, you can use the uv tool.

```bash
pipx install torrra
# or uv tool install torrra
```

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

### Run torrra from Development Setup

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

Execute the torrra application using 'uv run' after setting up the development environment.

```bash
uv run torrra
```

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

### Install torrra using Homebrew

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Install torrra on macOS using Homebrew. This method installs the precompiled binary version and requires no additional Python setup.

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

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

### Set up local development environment for torrra

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Clone the torrra repository and install dependencies using uv or pip for local development. This allows you to run torrra directly from its source code.

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

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

### Run torrra directly using Nix

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Execute torrra directly from its GitHub repository using Nix without a formal installation. This requires Nix to be installed.

```sh
nix run github:stabldev/torrra
```

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

### Display Torrra Version

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Retrieves and displays the currently installed version of the torrra application.

```bash
torrra --version
```

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

### Get Configuration Value via CLI

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

Retrieve the current value of a specific configuration key, such as the download path, using the 'torrra config get' command.

```bash
torrra config get general.download_path

```

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

### Get a Configuration Value

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Retrieves the value associated with a specific configuration key within torrra's settings.

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

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

### List All Configuration Values via CLI

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

Display all currently configured settings and their values by running the 'torrra config list' command.

```bash
torrra config list

```

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

### Initialize Torrra with Jackett

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Use this command to configure torrra to use Jackett as your torrent indexer. Ensure you replace the placeholder with your actual Jackett API key and URL.

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

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

### List All Configuration Values

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Displays all currently set configuration values within torrra.

```bash
torrra config list
```

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

### Launch Torrra with a default indexer

Source: https://github.com/stabldev/torrra/blob/main/README.md

Launch the Torrra CLI tool. If a default indexer is configured, it will be used automatically.

```bash
torrra # if default indexer is configured
# or torrra jackett
# or torrra jackett --url http://localhost:9117 --api-key <your_api_key>
```

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

### Clone Your Fork

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

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
```

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

### Make standalone binary executable

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

After downloading a standalone binary for Linux or macOS, make it executable using chmod. Replace the placeholder with the actual downloaded filename.

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

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

### Run torrra with Docker (Quick Usage)

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Execute torrra using its Docker image for quick usage without persistent configuration. Replace placeholders with your specific indexer details.

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

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

### Configure Jackett indexer settings

Source: https://github.com/stabldev/torrra/blob/main/README.md

Configure Jackett indexer settings, including its URL and API key, and set it as the default indexer.

```bash
# set your Jackett URL and API key
torrra config set indexers.jackett.url http://localhost:9117
torrra config set indexers.jackett.api_key <your_api_key>

# set Jackett as the default indexer
torrra config set indexers.default jackett
```

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

### Display Indexer Command Help

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Shows specific help information for the Jackett or Prowlarr indexer commands, detailing available options.

```bash
torrra jackett --help
# or torrra prowlarr --help
```

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

### Run torrra with Docker (Mounted Volumes)

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

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

```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>
```

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

### Initialize Torrra with Prowlarr

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Configure torrra to use Prowlarr as your torrent indexer. Replace the placeholder with your Prowlarr API key and URL. For best results, ensure 'Prefer Magnet URL' is enabled in Prowlarr.

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

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

### Launch Torrra with default indexer after configuration

Source: https://github.com/stabldev/torrra/blob/main/README.md

Launch Torrra after configuring a default indexer. The tool will automatically use the configured default.

```bash
torrra # default indexer will be used
```

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

### Set Theme via CLI

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

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

```bash
torrra config set general.theme gruvbox

```

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

### Download torrents directly

Source: https://github.com/stabldev/torrra/blob/main/README.md

Download torrents directly from magnet URIs or .torrent files using the 'download' command.

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

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

### Access Configuration Subcommands

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Enters the configuration management mode for torrra, allowing access to subcommands for managing settings.

```bash
torrra config
```

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

### Display General Help Message

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

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

```bash
torrra --help
```

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

### Directly Search for Torrents

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Perform an immediate search for torrents using a specific query. This bypasses the initial welcome screen.

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

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

### Push to Your Fork

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

Push your committed changes to your forked repository on GitHub.

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

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

### Set a Configuration Value

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Sets a specified configuration key to a new value in torrra's settings.

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

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

### Commit Changes

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

Stage all changes and commit them with a descriptive message, using conventional commit prefixes like 'feat:' or 'fix:'.

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

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

### Set Theme in config.toml

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

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

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

```

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

### Search for torrents directly

Source: https://github.com/stabldev/torrra/blob/main/README.md

Perform a direct search for torrents using the 'search' command, optionally with the --no-cache flag.

```bash
torrra search "arch linux iso"
# or torrra search "arch linux iso" --no-cache
```

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

### Set Configuration Value via CLI

Source: https://github.com/stabldev/torrra/blob/main/docs/configuration.md

Update a configuration setting, like 'download_in_external_client', to a new value using the 'torrra config set' command.

```bash
torrra config set general.download_in_external_client true

```

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

### Create a New Branch

Source: https://github.com/stabldev/torrra/blob/main/docs/contributing.md

Create a new branch for your feature or bug fix using Git.

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

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

### Add torrra to NixOS configuration

Source: https://github.com/stabldev/torrra/blob/main/docs/installation.md

Integrate torrra into your NixOS system configuration by adding its flake URL to your inputs and including it in 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 ];
```

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

### Directly Search for Torrents without Cache

Source: https://github.com/stabldev/torrra/blob/main/docs/usage.md

Execute a torrent search while disabling the caching feature. This ensures fresh results are fetched.

```bash
torrra search "ubuntu iso" --no-cache
```
Tokens:
Raw