Windows: qbit-manage-windows-amd64.exe
macOS: qbit-manage-macos-arm64 (Apple Silicon) or qbit-manage-macos-x86_64 (Intel)
Linux: qbit-manage-linux-amd64 (x86_64) or qbit-manage-linux-arm64 (ARM64/Raspberry Pi)

Perfect for server environments, automation, or users who prefer command-line tools.

3. Docker Container

Multi-architecture support (amd64, arm64, arm/v7)
Ideal for containerized environments and NAS systems

4. Python Installation

Install from source or PyPI
For developers or users who want to modify the code

Detailed Installation Guides

Desktop App Installation
Standalone Binary Installation
Python/Source Installation
Docker Installation
unRAID Installation

Desktop App Installation

Windows

Download qBit.Manage_<version>_x64-desktop-installer-setup.exe from the releases page
Run the installer and follow the setup wizard
Launch qBit Manage from the Start Menu or desktop shortcut
The app will automatically create the configuration directory and files

macOS

Download the appropriate .dmg from the releases page:
- qBit.Manage_<version>_aarch64-desktop-installer.dmg for Apple Silicon (M1+)
- qBit.Manage_<version>_x64-desktop-installer.dmg for Intel Macs
Open the DMG file and drag qBit Manage to your Applications folder
The app is not code-signed. To open it, remove the quarantine attribute:
```
xattr -cr /Applications/qBit\ Manage.app
```
Launch qBit Manage from Applications
The app will automatically create the configuration directory and files

Linux

Download the appropriate .deb installer from the releases page:
- qBit.Manage_<version>_amd64-desktop-installer.deb for x86_64 systems
- qBit.Manage_<version>_arm64-desktop-installer.deb for ARM64 systems (Raspberry Pi, etc.)

Install using your package manager:

sudo dpkg -i qBit.Manage_*-desktop-installer.deb
sudo apt-get install -f  # Fix any dependency issues

Launch qBit Manage from your applications menu or run qbit-manage in terminal
The app will automatically create the configuration directory and files

Standalone Binary Installation

Windows

Download qbit-manage-windows-amd64.exe from the releases page
Place the executable in a directory of your choice (e.g., C:\Program Files\qbit-manage\)
Add the directory to your PATH environment variable (optional)
Run from Command Prompt or PowerShell:
```
qbit-manage-windows-amd64.exe --help
```

macOS

Download the appropriate binary from the releases page:
- qbit-manage-macos-arm64 for Apple Silicon Macs (M1, M2, M3, etc.)
- qbit-manage-macos-x86_64 for Intel Macs

Remove the quarantine attribute and make executable:

xattr -cr qbit-manage-macos-*
chmod +x qbit-manage-macos-*

Move to a directory in your PATH (optional):

sudo mv qbit-manage-macos-* /usr/local/bin/qbit-manage

Run the binary:
```
./qbit-manage-macos-* --help
```

Linux

Download the appropriate binary from the releases page:
- qbit-manage-linux-amd64 for x86_64 systems
- qbit-manage-linux-arm64 for ARM64 systems (Raspberry Pi, etc.)
Make the binary executable (substitute arm64 for ARM64 systems):
```
chmod +x qbit-manage-linux-amd64
```

Move to a directory in your PATH (optional):

sudo mv qbit-manage-linux-amd64 /usr/local/bin/qbit-manage

Run the binary:
```
./qbit-manage-linux-amd64 --help
```

Python/Source Installation

For developers or users who want to modify the code, you can install from source or PyPI.

Prerequisites

Python 3.9 or higher
Git (for source installation)

Method 1: Install from PyPI

# Install uv first
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install qbit-manage
uv tool install qbit-manage

Method 2: Install from Source

# Clone the repository
git clone https://github.com/StuffAnThings/qbit_manage.git
cd qbit_manage

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install the package
uv tool install .

Running qbit-manage

After installation, you can run qbit-manage from anywhere:

# Show help and available options
qbit-manage --help

# Run once (without scheduler)
qbit-manage --run

# Run with web UI (default on desktop)
qbit-manage --web-server

# Run without web UI (force disable)
qbit-manage --web-server=False

Usage

After installation, you can run qbit_manage using:

qbit-manage --help

Tip

For Python installations, it's recommended to use a virtual environment to avoid conflicts with other packages.

Development Installation

For development work or to contribute to the project:

# Clone the repository
git clone https://github.com/StuffAnThings/qbit_manage.git
cd qbit_manage

# Install uv if not already installed
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # Linux/macOS
# .venv\Scripts\activate  # Windows

# Install in development mode
uv pip install -e .

Updating

Tool installation:

uv tool upgrade qbit-manage

Development installation:

cd qbit_manage
git pull
uv pip install -e . --upgrade

Quick Reference: Default Configuration File Locations

Desktop App & Standalone Binary

Windows: %APPDATA%\qbit-manage\config.yml
macOS: ~/Library/Application Support/qbit-manage/config.yml
Linux: ~/.config/qbit-manage/config.yml

Docker Installation

Container Path: /app/config.yml
Host Mount: Typically mounted from /path/to/your/config:/config

Custom Location

You can override the default location using the --config-dir or -cd command line option:

qbit-manage --config-dir /path/to/your/config/directory

Home
- Installation
- Config Setup
  - Sample Config File
  - List of variables
    - commands
    - qbt
    - settings
    - directory
    - cat
    - cat_change
    - tracker
    - nohardlinks
    - share_limits
    - recyclebin
    - orphaned
    - apprise
    - notifiarr
    - webhooks
- Commands
- Web API
- Web UI
- Contributing & Building
- Extras
  - Standalone Scripts
  - V4 Migration Guide

Want to contribute to this Wiki or have suggestions?

Fork it and send a pull request.

Submit a Docs request.