QuickBox Pro Command Line Interface

  1. Home
  2. Knowledge Base
  3. CLI Usage
  4. QuickBox Pro Command Line Interface

Despite having an easy to use dashboard, some users prefer using terminal to execute certain commands! We’ve compiled a list of all QuickBox Pro commands to make life a little bit easier. Please note: the commands below only work on version 1.2.3 and below unless otherwise stated.

In order for these commands to work, you must do sudo su - first then type in your command.

Auto Complete
Following version 1.6.4 you’ll now be able to tab to autocomplete. Simply start typing a command and hit tab you’ll be presented with a list of valid qb commands, if there is only a single possible command following your input, tab will complete your current input to that.

System Commands:

clean log – Clean SQL App Log
clean mem – Clean System memory
fix dpkg – Fixes dpkg locks
fix encode – Fixes ionCube installation
fix php – Fixes wrong PHP version
fix siteroot domain.com – Fixes the siteroot on incorrect entry
fix version – Fixes current QuickBox Pro Version
fix website – Fixes common website issues
logGen – Generates system logs to /tmp/qbLog.tar.gz
nginxUpdate help – Information about the nginxUpdate command
quickSupport help – Information about the quickSupport command
reload – Reload autodl-irssi and rtorrent for the user
updateNotice – Checks for QuickBox Pro update
updateQuickBox – Updates QuickBox Pro

System Commands (version 1.3.0 and above):

qb api – Enters API Management
qb api APIKEY – Forcibly enters new API Key
qb dashboard old/new – Toggles the two QuickBox Dashboards
qb clean <option> – Clean SQL App Log
qb fix dpkg – Fixes dpkg locks
qb fix encode – Fixes ionCube installation
qb fix php – Fixes wrong PHP version
qb fix siteroot domain.com – Fixes the siteroot on incorrect entry
qb fix version – Fixes current QuickBox Pro Version
qb fix website – Fixes common website issues
qb support enable/disable – Enables/Disables QuickBox support user account
qb update check– Checks for QuickBox Pro update (Reports to Dashboard)
qb update install– Updates QuickBox Pro
qb auto update enable/disable– Enables/Disables auto updates for QuickBox Pro

User Management Commands:

manageUser admin 'username' – Promotes ‘username’ to Super Admin
manageUser ban 'username' – Bans ‘username’ from accessing applications
manageUser create 'username' 'password' – Creates a new user
manageUser change 'username' 'newpass' – Updates password for ‘username’
manageUser delete 'username' – Deletes the specified user
manageUser set 'username' 500GB – Sets the quota for ‘username’ to 500GB
manageUser show 'username' – Shows the disk space used by ‘username’
manageUser unban 'username' – Unbans ‘username’

User Management Commands (for version 1.3.0 and above):

qb user set [username] [size]
qb user [admin|ban|delete|show|unban] [username]
qb user create [username] ['password'] [size(if quota)]
qb user password [username] ['new password']

Application Commands:

appname install – Installs application for all users
appname install username – Installs application for username
appname remove – Removes application for all users
appname remove username – Removes application for username
appname update – Updates application for all users
appname update username – Updates application for username
rtorrent install 0.9.4 – Installs rtorrent 0.9.4
rtorrent install 0.9.6 – Installs rtorrent 0.9.6
rtorrent install 0.9.7 – Installs rtorrent 0.9.7
rtorrent install feature-bind – Installs rtorrent feature-bind
rtorrent remove 0.9.4 – Removes rtorrent 0.9.4
rtorrent remove 0.9.6 – Removes rtorrent 0.9.6
rtorrent remove 0.9.7 – Removes rtorrent 0.9.7
rtorrent remove feature-bind – Removes rtorrent feature-bind
vpn install – Installs OpenVPN
vpn update – Updates OpenVPN configuration
vpn remove – Removes OpenVPN

In version 1.5.0 and above, most of the commands have now changed. For example, to install Plex (or any application), the command you would type is;

qb install plex <username>

So for uninstalling Plex (or any application) you would type the following;

qb remove plex <username>

You can replace Plex with any application name.

Unifi Controller
qb install unifi yourdomain.com – Installs Unifi

Was this article helpful?

Guidelines

Please add bugs found in QuickBox Pro using this template:

Bug Report
Select Bug Report as the issue template

Please add feature requests for application inclusion in QuickBox Pro using this template:

Application Feature Request
Select Application Feature Request as the issue template

Please add feature requests for general QuickBox Pro using this template:

Select General Feature Request as the issue template
Select General Feature Request as the issue template

Viewing issues as well as feature requests does not require an account.

You will need to create an account on our Lab in order to post both Issues as well as Feature Requests.
You can register an account here if you do not already have one.

We look forward to your reports as well as your ideas and suggestions for ongoing developments to the QuickBox Pro software!

The QuickBox Pro Community Appreciation Day Event Sale is in full effect.
Get your savings on!
00
Days
00
Hours
00
Minutes
00
Seconds