Fresh start - excluded large ROM JSON files
This commit is contained in:
122
skills/qbittorrent/README.md
Normal file
122
skills/qbittorrent/README.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# qBittorrent Skill
|
||||
|
||||
Manage torrents via qBittorrent WebUI from Clawdbot.
|
||||
|
||||
## What It Does
|
||||
|
||||
- **List torrents** — filter by status, category, or tags
|
||||
- **Add torrents** — by magnet link, URL, or local file
|
||||
- **Control downloads** — pause, resume, delete, recheck
|
||||
- **Speed limits** — set upload/download limits
|
||||
- **Categories & tags** — organize your torrents
|
||||
|
||||
## Setup
|
||||
|
||||
### 1. Enable WebUI
|
||||
|
||||
1. Open qBittorrent
|
||||
2. Go to **Tools → Options → Web UI**
|
||||
3. Enable **Web User Interface (Remote control)**
|
||||
4. Set a username and password
|
||||
5. Note the port (default: 8080)
|
||||
|
||||
### 2. Create Credentials File
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.clawdbot/credentials/qbittorrent
|
||||
cat > ~/.clawdbot/credentials/qbittorrent/config.json << 'EOF'
|
||||
{
|
||||
"url": "http://localhost:8080",
|
||||
"username": "admin",
|
||||
"password": "your-password-here"
|
||||
}
|
||||
EOF
|
||||
```
|
||||
|
||||
Replace with your actual WebUI credentials.
|
||||
|
||||
### 3. Test It
|
||||
|
||||
```bash
|
||||
./skills/qbittorrent/scripts/qbit-api.sh version
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### List torrents
|
||||
|
||||
```bash
|
||||
# All torrents
|
||||
qbit-api.sh list
|
||||
|
||||
# Filter by status
|
||||
qbit-api.sh list --filter downloading
|
||||
qbit-api.sh list --filter seeding
|
||||
qbit-api.sh list --filter paused
|
||||
|
||||
# Filter by category
|
||||
qbit-api.sh list --category movies
|
||||
```
|
||||
|
||||
### Add torrents
|
||||
|
||||
```bash
|
||||
# By magnet link
|
||||
qbit-api.sh add "magnet:?xt=..." --category movies
|
||||
|
||||
# By .torrent file
|
||||
qbit-api.sh add-file /path/to/file.torrent --paused
|
||||
```
|
||||
|
||||
### Control torrents
|
||||
|
||||
```bash
|
||||
qbit-api.sh pause <hash> # or "all"
|
||||
qbit-api.sh resume <hash> # or "all"
|
||||
qbit-api.sh delete <hash> # keep files
|
||||
qbit-api.sh delete <hash> --files # delete files too
|
||||
```
|
||||
|
||||
### Speed limits
|
||||
|
||||
```bash
|
||||
qbit-api.sh transfer # view current speeds
|
||||
qbit-api.sh set-speedlimit --down 5M --up 1M
|
||||
```
|
||||
|
||||
### Categories & tags
|
||||
|
||||
```bash
|
||||
qbit-api.sh categories
|
||||
qbit-api.sh tags
|
||||
qbit-api.sh set-category <hash> movies
|
||||
qbit-api.sh add-tags <hash> "important,archive"
|
||||
```
|
||||
|
||||
## Environment Variables (Alternative)
|
||||
|
||||
Instead of a config file, you can set:
|
||||
|
||||
```bash
|
||||
export QBIT_URL="http://localhost:8080"
|
||||
export QBIT_USER="admin"
|
||||
export QBIT_PASS="your-password"
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"QBIT_URL must be set"**
|
||||
→ Check your config file exists at `~/.clawdbot/credentials/qbittorrent/config.json`
|
||||
|
||||
**Connection refused**
|
||||
→ Make sure WebUI is enabled in qBittorrent settings
|
||||
|
||||
**403 Forbidden**
|
||||
→ Check username/password, or whitelist your IP in qBittorrent WebUI settings
|
||||
|
||||
**"Banned" after too many attempts**
|
||||
→ qBittorrent bans IPs after failed logins — wait or restart qBittorrent
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user