CLI Reference

QuickBox Pro provides a powerful command-line interface (CLI) for managing your server and applications. All operations can be performed using the qb command—from installing applications to managing users, performing system maintenance, and configuring advanced settings.

Installation

How to Install QuickBox Pro

Before using the qb CLI tool, you need to install QuickBox Pro on your server. The installation process is simple and takes just a few minutes.

View Installation Guide

Quick Installation Overview

Elevate to root:
```
sudo -i
```
Update your system:
```
apt-get -y update && apt-get -y upgrade
```

Download and run installer:


curl -sL "https://github.com/QuickBox/pro-v3/raw/refs/heads/main/qbpro_v3" > qbpro && chmod +x qbpro
./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY'

Get Your API Key

Your API Key is available at v3.quickbox.io/dashboard/api-keys

For complete installation instructions, supported operating systems, and advanced options, see the Getting Started guide

Quick Start

The qb command is your all-in-one interface for QuickBox Pro. The basic syntax follows this pattern:


qb [COMMAND] [SUBCOMMAND] [OPTIONS]

Common Examples:


# Install applications for a specific user
qb install sonarr -u myuser
qb install radarr -u myuser --4k
 
# Manage users and permissions
qb user create -u newuser -p 'password' -e user@example.com
qb user quota -u myuser -o 2TB
 
# System maintenance
qb clean memory
qb fix database
qb update quickbox
 
# Get help for any software command
qb help [Tab X2] (for suggestions)

Autocomplete at your fingertips

Hit Tab×Tab after qb, any command, or a software name to reveal completions instantly. It works for users, software, and nested commands.

Autocomplete & keyboard tips

Autocomplete shortcuts

Press Tab×Tab after qb, a command, or a software name to trigger the built-in autocomplete (from the quickbox completion script). It suggests commands, subcommands, usernames, and software names dynamically.
Use it with nested commands too, e.g., qb manage wireguard then Tab×Tab to see WireGuard actions.
When exploring, type qb help then tap Tab×Tab to list available help topics.

CLI Features

🚀 60+ Applications

One-command installation for all supported software

👥 Multi-User Support

Create and manage multiple users with individual quotas

🔧 System Management

Database, API keys, SSL certificates, and more

🛡️ Security First

API key validation, permission checks, encrypted credentials

📊 Intelligent Logging

Comprehensive logging for all operations

⚡ Auto-Configuration

Smart defaults with extensive customization options

Core Commands

Application Management

Install, update, remove, or reinstall any of the 60+ supported applications:


# Install an application
qb install [software] -u username [options]
 
# Remove an application
qb remove [software] -u username [options]
 
# Update an application to the latest version
qb update [software] -u username [options]
 
# Reinstall an application (preserves configuration)
qb reinstall [software] -u username [options]
 
# Get help for a specific application
qb help [software]

Examples:


qb install sonarr -u john
qb install radarr -u john --4k --nightly
qb update plex -u john
qb remove qbittorrent -u john

System Commands

qb help

Display help information for any command

qb help [software]

Learn more →

qb user

Manage dashboard users and permissions

qb user [action] -u username

Learn more →

qb clean

Clean logs, caches, and temporary files

qb clean [type] -u username

Learn more →

qb fix

Repair common issues and reset configurations

qb fix [component]

Learn more →

qb update

Update QuickBox components and system

qb update [component]

Learn more →

qb manage

System configuration - API keys, database, backups

qb manage [component]

Learn more →

All CLI Commands

User Management

user - Complete user account management (create, delete, password, quota, permissions)

System Management

manage - System configuration (API keys, database, language, trackers, backups)
clean - Clean logs, caches, and temporary files
fix - Fix common issues (permissions, PHP, Python, database)
update - Update QuickBox and check for new versions

Utilities

generate - Generate system logs and reports
support - Create temporary support access account
news - View QuickBox news and updates

Software Operations

install - Install applications for users
remove - Remove installed applications
update - Update applications to latest version
reinstall - Reinstall applications (preserves config)
help - Display help for any software

Advanced

dns-credentials - Manage DNS provider credentials for SSL
dns-test - Test DNS configuration
dns-setup - Setup DNS for SSL certificates

Common Operations

Installing Applications

Install any of the 60+ applications from the Applications section:


# Basic installation
qb install sonarr -u username
qb install radarr -u username
 
# With application-specific options
qb install radarr -u username --4k          # 4K variant
qb install sonarr -u username --nightly     # Nightly build
qb install plex -u username -d plex.example.com
 
# Admin-only software
qb install fail2ban
qb install netdata -u username
qb install wireguard -u username
 
# SSL certificates for multiple apps
qb install lecert -d example.com --dash --plex --jellyfin

Multi-User vs Admin Software

Most applications are multi-user (installed per user). Some like Fail2ban, Netdata, and WireGuard are admin-only (system-wide installation). You can see more in the Applications section.

User Management


# Create a new user
qb user create -u newuser -p 'password' -e user@example.com
 
# Change user password
qb user password -u username -p 'newpassword'
 
# Set disk quota
qb user quota -u username -o 2TB
qb user quota -u username -o 500GB
 
# Manage user permissions
qb user promote -u username    # Promote to admin
qb user demote -u username     # Demote to standard user
 
# Ban/unban users
qb user ban -u username
qb user unban -u username
 
# Show user information
qb user show -u username
 
# Delete user (removes all data)
qb user delete -u username

User Deletion

Deleting a user removes all their data, installed applications, and configurations. This action cannot be undone.

System Maintenance


# Clean operations
qb clean memory                          # Drop system caches
qb clean system_logs -o 7                # Remove logs older than 7 days
qb clean qb_logs -u username             # Clean QuickBox UI logs
qb clean dashboard_logs -u username      # Clean dashboard logs
qb clean rclone_logs -u username         # Clean rclone upload logs
 
# Fix operations
qb fix database                          # Fix database issues and remove duplicates
qb fix home -u username                  # Fix user home directory permissions
qb fix permissions -u username           # Fix user permissions on /opt/<username> and correct /etc/group membership
qb fix php                               # Fix PHP configuration and extensions
qb fix python                            # Fix Python configuration (PEP 668)
qb fix version                           # Reinstall QuickBox to latest version
 
# Update operations
qb update check                          # Check for updates
qb update quickbox                       # Install latest QuickBox version

System Configuration


# API key management
qb manage api                           # View current API key status
qb manage api -k qbp_YOUR_KEY           # Activate/update API key
qb manage api -o deactivate             # Deactivate API key
 
# Telemetry settings
qb manage telemetry -o enable           # Enable telemetry
qb manage telemetry -o disable          # Disable telemetry
 
# Database management
qb manage db -o mysql                   # Switch to MySQL database
qb manage db -o sqlite                  # Switch back to SQLite
qb manage db -o backup                  # Create database backup
qb manage db -o restore                 # Restore from backup
 
# Language settings
qb manage lang -o english
qb manage lang -o french
 
# Dashboard URL configuration
qb manage webroot -o your-domain.com
qb manage webroot -o 192.168.1.100
 
# Software backup and restore
qb manage software -o backup -u username -s sonarr
qb manage software -o restore -u username -s sonarr
qb manage software -o rollback -u username -s radarr

Support & Troubleshooting


# Generate system log for support
qb generate logs
 
# Enable temporary support account (24-hour access)
qb support enable
qb support status
qb support disable
 
# View QuickBox news and updates
qb news
 
# Get help for specific software
qb help sonarr
qb help plex
qb help radarr

Application-Specific Options

Many applications support specialized installation options:

Media Management (*arr Applications)


# Install 4K variants
qb install radarr -u username --4k
qb install sonarr -u username --4k
qb install bazarr -u username --4k
 
# Install nightly/development builds
qb install sonarr -u username --nightly
qb install radarr -u username --nightly
 
# Upgrade to version 4 (Sonarr)
qb update sonarr -u username --v4
 
# Combine options
qb install radarr -u username --4k --nightly

Plex Media Server


# Basic installation
qb install plex -u username
 
# With domain for reverse proxy
qb install plex -u username -d plex.example.com
 
# With custom data directory
qb install plex -u username -D /mnt/storage/plex
 
# With Plex claim token (for immediate server access)
qb install plex -u username -pct claim-xxxxxxxxxxxxx

Getting Your Plex Claim Token

Visit plex.tv/claim to generate a claim token. Tokens are valid for 4 minutes.

SSL Certificates (Let’s Encrypt)


# Basic domain certificate
qb install lecert -d example.com
 
# With specific applications
qb install lecert -d example.com --dash
qb install lecert -d example.com --plex
qb install lecert -d example.com --emby
qb install lecert -d example.com --jellyfin
qb install lecert -d example.com --overseerr
qb install lecert -d example.com --jellyseerr
 
# Multiple applications at once
qb install lecert -d example.com --dash --plex --jellyfin --overseerr
 
# Using DNS challenge (for servers behind firewalls)
qb install lecert -d example.com --dns --dns-provider cloudflare --dash
 
# Staging mode (for testing)
qb install lecert -d example.com --staging --dry-run

Supported DNS Providers:

CloudFlare
Route53 (AWS)
DigitalOcean
Linode
And more…

ruTorrent Plugins


# Install specific ruTorrent plugin
qb manage software -o rutorrent -o install -rup _cloudflare
qb manage software -o rutorrent -o install -rup ratiocolor
qb manage software -o rutorrent -o install -rup throttle

FileBot


# Install with specific torrent client integration
qb install filebot -u username -o sabnzbd
qb install filebot -u username -o rtorrent
qb install filebot -u username -o qbittorrent
 
# With custom media path
qb install filebot -u username -mp /mnt/media

Global Options

These options work with most commands:

Option	Long Form	Description	Example
`-h`	`--help`	Display help information	`qb --help`
`-v`	`--verbose`	Enable verbose output	`qb -v install sonarr -u john`
`-f`	`--force`	Force operation (skip confirmations)	`qb install sonarr -f -u john`
`-u`	`--username`	Specify username	`qb install sonarr -u john`
`-p`	`--password`	Specify password	`qb user create -u john -p 'pass123'`
`-e`	`--email`	Specify email address	`qb user create -u john -e john@example.com`
`-s`	`--software`	Specify software name	`qb install -s sonarr -u john`
`-o`	`--option`	Pass options to command	`qb clean system_logs -o 7`
`-k`	`--key`	Specify API key	`qb manage api -k qbp_YOUR_KEY`
`-d`	`--domain`	Specify domain (for SSL)	`qb install lecert -d example.com`

Application-Specific Options:

--4k - Install 4K variant (*arr applications)
--nightly - Install nightly/development build
--v4 - Update to version 4 (Sonarr)
-pct - Plex claim token
-rup - ruTorrent plugin name
-mp - Media path (FileBot)
--dns - Use DNS challenge (Let’s Encrypt)
--dns-provider - DNS provider name
--staging - Use staging environment
--dry-run - Simulation mode

Getting Help

Command Help

Get detailed help for any command or software:


# General help
qb --help
qb -h
 
# Software-specific help
qb help sonarr
qb help radarr
qb help plex
 
# Command-specific help (Coming Soon!)
qb user --help
qb manage --help
qb clean --help

Application Documentation

For detailed application setup and configuration guides:

Browse the Applications section
Check application-specific documentation pages
Visit the Troubleshooting guide

Tips & Best Practices

📖 Read Help First

Always run 'qb help [software]' before installing to see all available options

🔄 Backup Before Changes

Use 'qb manage software -o backup' before major updates or reinstalls

📝 Check Logs

Command logs are stored in /opt/quickbox/logs/ for troubleshooting

🔐 Secure Your API Key

Never share your API key publicly - it provides full server access

⚡ Use Batch Scripts

Automate repetitive tasks with shell scripts for multiple users

🗄️ Database Backups

Run 'qb manage db -o backup' regularly to protect your configuration

Advanced Usage

Batch Operations

Automate installation for multiple applications or users:


# Install multiple apps for a user
for app in sonarr radarr lidarr prowlarr jackett; do
  qb install $app -u username
done
 
# Install the same app for multiple users
for user in alice bob charlie; do
  qb install qbittorrent -u $user
done
 
# Update all *arr applications
for app in sonarr radarr lidarr prowlarr readarr; do
  qb update $app -u username
done

Database Management


# Switch from SQLite to MySQL for better performance
qb manage db -o mysql \
  --user='admin' \
  --pass='secure_password' \
  --port='3306' \
  --host='localhost' \
  --name='qbpro'
 
# Create regular backups
qb manage db -o backup
 
# Restore from backup
qb manage db -o restore
 
# Database maintenance and optimization
qb manage db -o maintenance

SSL Certificate Management


# Setup DNS credentials for automated renewal
qb dns-credentials setup cloudflare
 
# Test DNS configuration
qb dns-test example.com
 
# Install certificates with DNS challenge (for servers behind NAT)
qb install lecert -d example.com --dns --dns-provider cloudflare --dash
 
# Renew certificates (automated via cron)
qb renew lecert
 
# Update existing certificate with more apps
qb ssl-update wsdashboard --plex --jellyfin

Troubleshooting

Common issues and solutions:

API Key Issues


# Check current API key status
qb manage api
 
# Reactivate with your API key
qb manage api -k qbp_YOUR_KEY
 
# If activation fails, try deactivating first
qb manage api -o deactivate
qb manage api -k qbp_YOUR_KEY

Database Problems


# Fix database issues and remove duplicates
qb fix database
 
# If issues persist, backup and reinstall
qb manage db -o backup
qb fix version

Permission Errors


# Fix user home directory permissions
qb fix home -u username
 
# Fix user application permissions
# and correct /etc/group membership
qb fix permissions -u username
 
# Fix PHP issues
qb fix php
 
# Force update to latest stable version (preserves user data)
qb fix version

Software Won’t Install


# Force reinstall
qb reinstall sonarr -u username
 
# Check logs for details
cat /opt/quickbox/logs/sonarr
 
# Generate system report for support
qb generate logs