QBitRun/README.md

26 lines
844 B
Markdown

# QBitRun
Runner application for qBittorrent.
---
# Anything Below This Line is not ready!!
---
## Quick Start
Start by copying the following command into the "Run external program on torrent completion" field in qBittorrent `Settings > Downloads`.
```sh
/path/to/qbitrun handle -N "%N" -L "%L" -G "%G" -F "%F" -R "%R" -D "%D" -C "%C" -Z "%Z" -T "%T" -I "%I" -J "%J" -K "%K"
```
If wanting to handle "Run external program on torrent torrent added", add `--add-event` (or `-a` for short) to the command. This is for the qbitrun and you to be able to distinguish whether this run is triggered by "torrent added" event.
```sh
/path/to/qbitrun handle --add-event -N "%N" -L "%L" -G "%G" -F "%F" -R "%R" -D "%D" -C "%C" -Z "%Z" -T "%T" -I "%I" -J "%J" -K "%K"
```
You can filter out which events to handle later in the runner .yaml files.