qbit-tui/README.md
2026-05-10 23:55:24 +02:00

45 lines
1.3 KiB
Markdown

# 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
```bash
cargo build --release
```
## Running
```bash
# 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