Skip to Content
CLI Referenceqb help

qb help - Command Help

Get Help

Display help information for QuickBox commands

The qb help command provides quick access to command usage information directly from your terminal. Get instant help on QuickBox CLI commands without leaving your SSH session.

Quick Reference

CommandDescription
qb help
Display general help and command list
qb help [command]
Show help for a specific command
qb --help
Alternative help flag
qb -h
Short help flag

Autocomplete & keyboard tips

Autocomplete at your fingertips
Tip

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

Autocomplete shortcuts
Info
  • 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.

Display General Help

Show the main help screen with available commands:

bash
qb help

What you’ll see:

  • Available command categories
  • List of all commands
  • Brief description of each command
  • Usage syntax
  • Common examples

Command-Specific Help

Get detailed help for a specific command:

bash
qb help [command]

Examples (Coming Soon!):

bash
# Get help for user management
qb user --help
 
# Get help for software installation
qb software --help
 
# Get help for general system management
qb manage --help
 
# Get help for system fixes
qb fix --help

Command help includes:

  • Detailed command description
  • Available options and flags
  • Usage examples
  • Related commands
  • Common use cases

Alternative Help Syntax

Multiple ways to access help:

bash
# Using help subcommand
qb help
 
# Using --help flag
qb --help
 
# Using short -h flag
qb -h
 
# Help for specific command
qb user --help
qb fix -h

All these methods display the same help information.

Help Categories

User Management

bash
qb help user      # User account management
qb help quota     # Disk quota management

System Management

bash
qb help manage    # Server management functions
qb help fix       # System repair tools
qb help clean     # Cleanup utilities

Software Management

bash
qb help software  # Application installation

Updates & News

bash
qb help update    # QuickBox updates
qb help news      # Latest announcements

Support

bash
qb help support   # Support access management

Quick Tips

Pro Tips

  • Use tab completion to see available commands
  • Check command help before running unfamiliar commands
  • Help output shows required vs optional parameters
  • Most commands support --help flag

Finding Commands

  • Not sure which command? Start with qb help
  • Look for commands by category
  • Read command descriptions to find what you need
  • Check related commands sections

Common Use Cases

First Time Setup

Getting familiar with QuickBox CLI:

bash
# 1. View all available commands
qb help
 
# 2. Learn about user management
qb help user
 
# 3. Understand software installation
qb help software
 
# 4. Review management functions
qb help manage

Before Running Commands

Verify command usage:

bash
# Check command syntax before using
qb help manage
 
# Review specific function
qb manage --help
 
# Understand options and flags
qb user --help
Read Before You Run
Tip

Always check command help if you’re unsure about syntax or options. This prevents mistakes and helps you understand what the command will do.

Troubleshooting

When things go wrong:

bash
# Check if you're using correct syntax
qb help fix
 
# Verify command options
qb fix --help
 
# Review available commands
qb help

Understanding Help Output

Command Syntax

How to read command syntax in help output:

plaintext
qb user create -u USERNAME -p PASSWORD
  • Bold/UPPERCASE = Required parameter (you must provide this)
  • [brackets] = Optional parameter (can be omitted)
  • | = OR (choose one option)
  • -u, —user = Flag with short and long form

Example:

plaintext
qb manage db -o [mysql|sqlite] [--user='USER'] [--pass='PASS']

This means:

  • -o is required, choose mysql or sqlite
  • --user and --pass are optional
  • If omitted, defaults are used

Online Documentation

While qb help provides quick CLI reference, comprehensive documentation is available online:

Online Resources:

Comprehensive Guides
Note

The online documentation includes detailed guides, examples, troubleshooting steps, and best practices that go beyond what’s available via CLI help.

News Command

View latest QuickBox announcements

Update Command

Check for and install updates

Support Command

Get temporary support access

Need More Help?

If the built-in help doesn’t answer your questions, join our Discord community for live support:

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

  • Dedicated Support
  • Feature Previews
  • Community Configs
  • Active Discussions
Join Discord Server

Additional Resources:

Last updated on
qb newsqb software