qbit-tui

A lightweight terminal UI for controlling a remote qBittorrent instance.

What it does

qbit-tui connects to a qBittorrent Web UI and displays your torrents in a real time table. You can pause, resume, delete torrents, add magnet links or .torrent files, toggle speed limits, and inspect detailed information including trackers, files, and peers. The interface features a sidebar for filtering by status, category, or tag, plus a details panel with four tabs.

Requirements

Rust toolchain (stable)
A running qBittorrent instance with the Web UI enabled

Configuration

The application reads connection settings from environment variables:

QBIT_URL : qBittorrent Web UI URL (default: http://localhost:8080)
QBIT_USER : Username (default: admin)
QBIT_PASS : Password (default: adminadmin)

Building

cargo build --release

The binary will be available at target/release/qbit-tui.

Installing

To make qbit-tui available system wide, copy the built binary into a directory that is in your PATH:

# For the current user only (recommended)
mkdir -p ~/.local/bin
cp target/release/qbit-tui ~/.local/bin/

# Or for all users (requires sudo)
sudo cp target/release/qbit-tui /usr/local/bin/

Make sure ~/.local/bin is in your PATH. If not, add this line to your shell profile (~/.bashrc, ~/.zshrc, etc.):

export PATH="$HOME/.local/bin:$PATH"

Running

# With defaults
cargo run

# With custom credentials
QBIT_URL=http://192.168.1.10:8080 QBIT_USER=admin QBIT_PASS=secret cargo run

Controls

License

MIT

1.8 KiB Raw Blame History