Skip to Content

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

CommandWhat it does
qb help
Prints the general screen: usage line, every command, the dns commands, and where to get more help
qb help <command>
Prints the usage line and docs link for one command, for example qb help user
qb help <app>
Prints the options for one application, for example qb help plex
qb help software
Lists every application you can install, with the multi-user and installed markers
qb -h or qb --helpOpens the full manual (man qb)

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.

The General Screen

bash
qb help

The screen has four parts:

  • Usage and commands: usage: qb <command> [options] followed by one line per command: install, reinstall, remove, update, renew, software, user, manage, fix, clean, generate, support, news, transfer, menu and help
  • dns: the four DNS commands, dns-credentials, dns-test, dns-detect and dns-setup
  • more help: the three qb help forms above plus man qb
  • Docs links: the QuickBox docs and the CLI reference

Running qb on its own opens the interactive menu instead.


Help for One Command

bash
qb help <command>

Prints a one-line description, the usage line, and a link to the docs page for that command:

bash
qb help user
qb help update
qb help transfer
qb help dns-setup

An unknown topic prints unknown help topic: <name>, then the general screen, and exits with status 1.

Retired SSL verbs
Info

The old ssl, ssl-remove and ssl-update commands no longer exist. Each one prints a pointer to qb install lecert and qb remove lecert, and qb help lecert shows the options. See Let’s Encrypt.


Help for an Application

bash
qb help <app>

When the topic is the name of an installable application, the help is that application’s own, including its options and examples:

bash
qb help plex
qb help lecert

To see which names are valid, list every installable application:

bash
qb help software

The Full Manual

bash
qb -h
qb --help

Both open the manual page (man qb). They do not print the screen that qb help prints. Adding -h or --help to a command line, for example qb user --help, also opens the manual, so use qb help <command> when you want the usage line for one command.


Quick Tips

Pro Tips

  • Use tab completion to see available commands
  • Check qb help <command> before running an unfamiliar command
  • Use qb help software to find the exact application name

Finding Commands

  • Not sure which command? Start with qb help
  • Each command line links to its docs page
  • Use man qb for the full manual

Common Use Cases

First Time Setup

bash
# 1. View all available commands
qb help
 
# 2. Learn about user management
qb help user
 
# 3. See which applications you can install
qb help software

Before Running Commands

bash
# Check the usage line for a command
qb help manage
 
# Check the options for an application
qb help plex
Read Before You Run
Tip

Check the usage line if you are unsure about syntax or options. This prevents mistakes and helps you understand what the command will do.


Reading a Usage Line

The usage lines qb help <command> prints use these conventions:

plaintext
qb user <create|delete|password|show|quota|ban|unban|promote|demote> -u <user>
qb update <app|quickbox|dashboard|check> [-u <user>]
  • <angle brackets> = a value you supply
  • [brackets] = optional
  • | = choose one

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.



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