# README
Telegram_qBittorrent_Notifier
A simple CLI tool for qBittorrent that sends a notification to Telegram chat via bot on torrent finished.
Quick Start
Installation
Download prebuilt statically-linked binaries from Releases for Linux, Windows and macOS.
Configuration
Please refer to the config example.
Integrate with qBittorrent
In the qBittorrent Web UI:
- Navigate to
Options
and select theDownloads
tab. - At the bottom, locate
Run external program on torrent finished
.
Handling Empty Category or Tags
When using %L
(Category) or %G
(Tags), follow these formats to avoid errors:
❯ Telegram_qBittorrent_Notifier send -n "%N" -l "6д9%L"
❯ Telegram_qBittorrent_Notifier send -n "%N" -g "6д9%G"
❯ Telegram_qBittorrent_Notifier send -n "%N" -l "6д9%L" -g "6д9%G"
These formats use "6д9" as a prefix to ensure that the CLI does not encounter parsing errors from empty values in %L
or %G
.
You can customize this magic word in the configuration file or by using the --magic-word
option.
Thumbnail
Enhance your notifications with the thumbnail feature for a more visually engaging experience.
When a valid video file is specified via --thumbnail-source
option, the tool uses FFmpeg to automatically generate a thumbnail, adding a visual element to your Telegram notifications.
❯ Telegram_qBittorrent_Notifier send --thumbnail-source "%F" -n "%N"
Please ensure FFmpeg is installed and can be executed directly from the command line. The tool performs an automatic check for FFmpeg. In case FFmpeg is not detected or cannot be executed, the thumbnail generation will not take place.
Support
If you encounter any issues or have any suggestions, please open an issue.
License
This project is licensed under the MIT License, see the LICENSE file for details.