# qBit Manage

<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>

qBit Manage is a tool to manage your [qBittorrent](https://docs.ultra.cc/books/qbittorrent/page/qbittorrent) instance from the CLI. Included features are change tag, categories, remove unregistered torrents, and a lot more.

- More information can be found [here](https://github.com/StuffAnThings/qbit_manage).

## Prerequisites

- Python version 3.8.1 or above. See [here](https://docs.ultra.cc/books/unofficial-language-installers-3AK/page/install-python-using-pyenv).
- [qBittorrent](https://docs.ultra.cc/books/qbittorrent/page/qbittorrent) instance installed on your service.

## Installation

<p class="callout info">
Do note, qBit Manage is only compatible with qBittorrent versions up to <code>4.6.2</code>. It is currently not working with the latest qBittorrent version <code>4.6.3</code>
</p>

- 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)
- Clone the qBit Manage repo to the `.apps` directory by executing the following command:
  
```sh
git clone https://github.com/StuffAnThings/qbit_manage ~/.apps/qbit_manage
```

- Navigate into the cloned repo directory.

```sh
cd ~/.apps/qbit_manage
```

- Next, install the required Python packages.
  - If you encounter issues with the following command, add `--ignore-installed` at the end of the command.

```sh
pip install -r requirements.txt
```

- Create a qBit Manage configuration file by copying `config.yml.sample`

```sh
cp ~/.apps/qbit_manage/config/config.yml.sample ~/.apps/qbit_manage/config/config.yml
```

- Open the configuration file with the editor. Find the `qbt:` section and add your qBittorrent connection details, which can be found on the [UCP](https://cp.ultra.cc).

```
nano ~/.apps/qbit_manage/config/config.yml
```

- Do note that the configuration file is just a template, and needs to be configured to match your specific setup., refer to [qBit Manage documentation](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) for more information.
- Once you have made your changes, press `ctrl+x` and `y` to save your changes and exit. Press `ENTER` to confirm.
- Confirm the installation was successful by executing the following command:
  - The `-h` option stands for help, and will print the help message.

```sh
python ~/.apps/qbit_manage/qbit_manage.py -h
```

- Done!

## Uninstallation

- Uninstalling qBit Manage is easily done by deleting the app directory:
  
```sh
rm -rf ~/.apps/qbit_manage
```

- Done!