A lightweight terminal UI for controlling a remote qBittorrent instance.
Find a file
2026-05-11 00:30:58 +02:00
src Fix peers endpoint: use /api/v2/sync/torrentPeers instead of /api/v2/torrents/peers 2026-05-11 00:30:58 +02:00
.gitignore Initial commit 2026-05-10 23:55:24 +02:00
Cargo.toml Add advanced features: search, sort, multi-select, missing QB actions, advanced add modal, notifications, file logging, and JSON parsing tests 2026-05-11 00:23:40 +02:00
README.md changes to README.md 2026-05-11 00:06:06 +02:00

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)

Or, you can alternatively fill out the form on the app startup with your credentials and URL to connect to your qBittorrent instance.

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

q: quit | Tab / h / l: change focus | ↑ / ↓ or k / j: navigate | p: pause/resume | x: delete | X: delete with files | i: toggle details panel | 1-4: switch detail tabs | a: add torrent file | m: add magnet | L: toggle speed limits

License

MIT