# qbittorrent-cli

<p class="callout warning">
This unofficial app installation guide is provided for your convenience. The guide is provided as-is and may not be updated or maintained by Ultra.cc. Unofficial support may be offered via <a href="https://discord.ultra.cc">Discord</a> only and at the sole discretion of Ultra.cc staff. Use at your own risk and only proceed if you are comfortable managing the application on your own.
</p>

qbittorrent-cli is a feature rich CLI to manage [qBittorrent](https://docs.ultra.cc/books/qbittorrent/page/qbittorrent). It provides features such as; Add torrents, categories, tags, reannounce and import torrent sessions from other clients.

- More information can be found [here](https://github.com/ludviglundgren/qbittorrent-cli).

## Installation

- Connect to your Ultra.cc service via [SSH](https://docs.ultra.cc/books/secure-shell-%28ssh%29/page/how-to-connect-to-your-ultracc-slot-via-ssh)
- Once connected, execute the following command:
  
```sh
bash <(wget -qO- https://scripts.ultra.cc/main-v2/qBittorrent-cli/main.sh)
```

- Type `1` and confirm with `ENTER` to proceed with the installation
- When prompted, enter your qBittorrent password
  - Your qBittorrent password can be found on the [UCP](https://cp.ultra.cc) 
- Confirm the installation was successful by executing the following command:

```
qbt help
```

- If successful, your terminal will output usage instructions for qbittorrent-cli.

## Usage

- **Print usage instructions:** `qbt help`
- **Print command specific usage instructions:** `qbt torrent import help`

qbittorrent-cli can do a lot of things. For example, to import your Deluge torrent session into qBittorrent, see the below command. You can do a test run of the command by appending `--dry-run` to the command.

<p class="callout info">
Before you start migrating your torrent session. Make sure you have set the same <b>Default save path</b> for your destination torrent client, as you have set for your source torrent client. Failing to do so would result in your new torrent client re-downloading all of your torrents again.
</p>

- Import torrent session to qBittorrent

```sh
qbt torrent import deluge --source-dir ~/.config/deluge/state/ --qbit-dir ~/.local/share/qBittorrent/BT_backup/
```

- Export torrent session from qBittorrent

```sh
qbt torrent export --source ~/.local/share/qBittorrent/BT_backup/ --export-dir ~/watch/deluge
```

- In the above command, we have used Deluge as an example. The paths can easily be replaced to match the path of other torrent clients. See them listed below.
<br><br>
- Paths to the torrent session state of each torrent client:
  - **Deluge**: `~/.config/deluge/state`
  - **qBittorrent**: `~/.local/share/qBittorrent/BT_backup`
  - **rTorrent**: `~/.config/rtorrent/session`
  - **Transmission**: `~/.config/transmission-daemon/torrents`
<br><br>
- Paths to the watch directory of each torrent client:
  - **Deluge**: `~/watch/deluge`
  - **qBittorrent**: `~/watch/qbittorrent`
  - **rTorrent**: `~/watch/rtorrent`
  - **Transmission**: `~/watch/transmission`

For more information about torrent session migration, see [this guide](https://docs.ultra.cc/books/torrent-clients/page/torrent-session-migration/).

## Uninstallation

- Execute the following command:
  
```sh
bash <(wget -qO- https://scripts.ultra.cc/main-v2/qBittorrent-cli/main.sh)
```

- Type `2` and confirm with `ENTER` to proceed with the uninstallation
  - The uninstallation will leave your configuration file untouched at `~/.config/qbt/.qbt.toml`
- Done!