Skip to content

enisz/bitbutler

Repository files navigation

BitButler

The digital butler for your torrents.

Version CI Status Downloads License

A clean, simple, and modern way to manage your qBittorrent-nox servers.

Main View

BitButler is a desktop remote client specifically designed to connect to and manage qBittorrent-nox instances. Instead of dealing with clunky web interfaces or browser tabs, BitButler gives you a dedicated, professional space to keep your downloads organized.

Torrent Detail View

It’s fast, it’s modern, and it works where you do.

Compatibility

Important note: currently the app supports the qBittorrent v4.1.0 - v4.6.x releases. Support for the latest API 5.x is coming soon.

Using with newer versions of the API may be possible, but can be buggy as there were some breaking changes.

Table of Contents

The Story Behind BitButler

BitButler is a hobby project born out of personal necessity. For years, I used Transmission paired with "Transmission Remote GUI" desktop client. When I eventually made the switch to qBittorrent, I really missed having a snappy, dedicated desktop application to manage my remote server.

I built BitButler to fill that gap: to give qBittorrent-nox users a fast, native-feeling desktop client that doesn't rely on keeping a web UI open in a browser tab.

Why use BitButler?

  • Clean & Modern: A fresh interface built for the modern desktop.
  • Fast Management: Quickly sort through hundreds of torrents, filter by state, and manage your queue without the lag.
  • Always Ready: As a standalone app, it’s always just an Alt+Tab away.
  • Safe & Private: Your server credentials and data stay on your machine. BitButler talks directly to your server and keeps things secure.
  • Multi-language Support: Use the app in your native tongue (currently supporting English and Hungarian).

Tech Stack

Tool Purpose Badge
Angular Frontend Framework Angular
Electron Desktop Shell Electron
SQLite Local Database SQLite
ag-Grid Data Management ag-Grid
TypeScript Logic & Types TypeScript

Localization

BitButler speaks multiple languages! Currently:

  • 🇺🇸 English (us.json)
  • 🇭🇺 Hungarian (hu.json)

Help the Butler Learn!

Want to see BitButler in your language? We make it easy to contribute. Language files are located in public/i18n/. You can simply copy us.json to a new file and translate the values.

Check our Contributing Guide for more details on how to submit a new language.

Quick Start

  1. Download & Install: Grab the latest version from the Releases page. You can find multiple formats depending on your preference:
    • Windows: Setup (.exe), Portable (.exe), or Archive (.zip)
    • Linux: AppImage, .deb, .rpm, .snap, or .tar.gz
  2. Connect: Enter your qBittorrent-nox server's IP address and credentials.
  3. Manage: Start organizing your torrents immediately.

Note: On Windows, you may see a "Windows protected your PC" warning. This is because the app is not signed with an expensive developer certificate. You can click "More info" and then "Run anyway" to start the Butler.

For the Developers

If you're a developer and want to play with the code or build a custom version:

Prerequisites

  • Node.js (v20 or higher)
  • npm
  • (Linux Only): rpm tools installed (sudo apt-get install rpm) to build the .rpm package.

Setup

# Clone the repo
git clone https://github.com/enisz/bitbutler.git

# Install dependencies
npm install

# Run in development mode
npm start

Building the App

Our build scripts automatically compile the Angular UI and package the Electron app into multiple distribution formats.

# Windows (Builds NSIS Installer, Portable, and ZIP)
npm run dist:win

# Linux (Builds AppImage, DEB, RPM, Snap, and Tarball)
npm run dist:linux

Community & Support

BitButler is an open-source project. If you have an idea for a feature or found something that isn't working quite right, feel free to open an issue or submit a pull request. I would love to hear how people use the "Butler."

Built with ❤️ for the community.

About

qBittorrent-nox remote client

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors