| docs

Appearance

CLI Reference ​

Complete reference of all bolt-cli commands available in panel v1.0.4. Selected commands have detailed guides — see Mail, Network, Security and User Management.

bolt-cli <command> is equivalent to bolt-shell bolt:<command>. Every command accepts --silent (suppress output) and --help.

Administration & maintenance ​

bolt-cli admin-sso-generate ​

Login to an account via token and URL

bash
bolt-cli admin-sso-generate [--expire [EXPIRE]]

Options:

  • --expire=<value> – Token lifetime (e.g. 30m, 2h, 24h, 7d)

bolt-cli admin-url ​

Get the admin URL for the Bolt control panel

bash
bolt-cli admin-url

bolt-cli app-activate ​

Activate a Bolt app

bash
bolt-cli app-activate <app>

Arguments:

  • app (required)

bolt-cli app-deactivate ​

Deactivate a Bolt App

bash
bolt-cli app-deactivate <app>

Arguments:

  • app (required)

bolt-cli apply-dns-template ​

Apply DNS template to hostname, domains, or both

bash
bolt-cli apply-dns-template [--type [TYPE]]

Options:

  • --type=<value> – What to apply DNS template to (hostname, domain, both)

bolt-cli change-hostname ​

Change the system hostname

bash
bolt-cli change-hostname

bolt-cli check-for-updates ​

Check for updates and notify admin if a new version is available

bash
bolt-cli check-for-updates [--force]

Options:

  • --force – Clear cached version info and notification state before checking

bolt-cli check-public-port-accessibility ​

Check accessibility of public ports

bash
bolt-cli check-public-port-accessibility

bolt-cli cloud-linux-api ​

CloudLinux API endpoint for integration with CloudLinux Manager

bash
bolt-cli cloud-linux-api [--request [REQUEST]] [--encoded-options [ENCODED-OPTIONS]]

Options:

  • --request=<value>
  • --encoded-options=<value>

bolt-cli connect-bolt-agent-with-panel ​

Connect Bolt Agent with the Panel

bash
bolt-cli connect-bolt-agent-with-panel

bolt-cli create-admin-account ​

Create an admin account for the admin panel

bash
bolt-cli create-admin-account

bolt-cli export-hosting-account ​

Export a hosting account by username

bash
bolt-cli export-hosting-account [--username [USERNAME]]

Options:

  • --username=<value>

bolt-cli firewall ​

Manage firewall rules

bash
bolt-cli firewall [--action [ACTION]] [--port [PORT]] [--zone [ZONE]] [--comment [COMMENT]] [--protocol [PROTOCOL]]

Options:

  • --action=<value>
  • --port=<value>
  • --zone=<value>
  • --comment=<value>
  • --protocol=<value>

bolt-cli flush-dns ​

Flush DNS cache for a domain

bash
bolt-cli flush-dns [--domain [DOMAIN]]

Options:

  • --domain=<value>

bolt-cli get-current-server-ip ​

Command description

bash
bolt-cli get-current-server-ip

bolt-cli get-status ​

Get the status of the Bolt installation

bash
bolt-cli get-status

bolt-cli health-check ​

Perform a health check on critical services and restart if necessary

bash
bolt-cli health-check

bolt-cli import-hosting-account ​

Import a hosting account by file

bash
bolt-cli import-hosting-account [--file [FILE]]

Options:

  • --file=<value>

bolt-cli imunify360-api ​

Imunify360 API endpoint for integration with Imunify360

bash
bolt-cli imunify360-api [--request [REQUEST]] [--encoded-options [ENCODED-OPTIONS]]

Options:

  • --request=<value>
  • --encoded-options=<value>

bolt-cli ping-domains ​

Ping all domains in the database and check if they are up or down.

bash
bolt-cli ping-domains

bolt-cli reconfigure-securebox ​

Reconfigure SecureBox for SSH users

bash
bolt-cli reconfigure-securebox

bolt-cli recovery ​

Recover Bolt application health

bash
bolt-cli recovery

bolt-cli refresh-hosting-accounts-stats ​

Refresh hosting accounts statistics

bash
bolt-cli refresh-hosting-accounts-stats

bolt-cli request-trial-license ​

Request trial license for your server

bash
bolt-cli request-trial-license

bolt-cli reset-admin-account-password ​

Reset the password of an admin account

bash
bolt-cli reset-admin-account-password

bolt-cli run-auto-ssl ​

Run AutoSSL for domains

bash
bolt-cli run-auto-ssl [--domain [DOMAIN]] [--force]

Options:

  • --domain=<value>
  • --force – Process all auto-renew certificates regardless of expiration

Show login link to admin panel

bash
bolt-cli show-login-to-admin-link

bolt-cli ssl-health-check ​

Check the health of SSL certificates on the server

bash
bolt-cli ssl-health-check

bolt-cli update-bolt-agent ​

Command description

bash
bolt-cli update-bolt-agent

Service management ​

bolt-cli manage-app ​

Run Adminbolt installers/uninstallers with live log tracking.

bash
bolt-cli manage-app [--app-name [APP-NAME]] [--action [ACTION]] [--operation-id [OPERATION-ID]]

Options:

  • --app-name=<value> – Installer alias (e.g. git)
  • --action=<value> – Action to perform: install|uninstall|upgrade
  • --operation-id=<value> – Optional operation id to track logs

bolt-cli manage-cloudlinux ​

Manage CloudLinux installations and configurations (install, remove, or check status)

bash
bolt-cli manage-cloudlinux [--action [ACTION]] [--api-key [API-KEY]] [--enable-php] [--enable-nodejs] [--enable-python] [--enable-ruby]

Options:

  • --action=<value> – Action to perform (install, remove, status)
  • --api-key=<value> – CloudLinux activation / API key (required for install)
  • --enable-php – Enable PHP selector
  • --enable-nodejs – Enable Node.js selector
  • --enable-python – Enable Python selector
  • --enable-ruby – Enable Ruby selector

bolt-cli manage-dns-records-default-template ​

Manage DNS records default template

bash
bolt-cli manage-dns-records-default-template [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install)

bolt-cli manage-dovecot ​

Manage Dovecot installations and configurations (install, remove, or check status)

bash
bolt-cli manage-dovecot [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-dovecot-profiles ​

Apply default Dovecot settings

bash
bolt-cli manage-dovecot-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-exim ​

Manage Exim installations and configurations (install, remove, or check status)

bash
bolt-cli manage-exim [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-exim-profiles ​

Apply default Exim settings

bash
bolt-cli manage-exim-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-fail2ban ​

Manage Fail2Ban installations and configurations (install, remove, or check status)

bash
bolt-cli manage-fail2ban [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-fail2ban-profiles ​

Apply system profiles for fail2ban

bash
bolt-cli manage-fail2ban-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-mailserver ​

Manage MailServer installations and configurations (install, remove, or check status)

bash
bolt-cli manage-mailserver [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-mariadb ​

Manage MariaDB installations and configurations (install, remove, or check status)

bash
bolt-cli manage-mariadb [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-mariadb-default-profile ​

Apply the current MariaDB default profile to the server.

bash
bolt-cli manage-mariadb-default-profile [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-mlmmj ​

Manage Mlmmj installations and configurations (install, remove, or check status)

bash
bolt-cli manage-mlmmj [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-mlmmj-profiles ​

Apply default Mlmmj settings

bash
bolt-cli manage-mlmmj-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-my-apache ​

Manage MyApache installations and configurations (install, remove, or check status)

bash
bolt-cli manage-my-apache [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-my-apache-default-profile ​

Apply the current MyApache default profile to the server.

bash
bolt-cli manage-my-apache-default-profile [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-my-apache-mod-passenger ​

Manage MyApache mod_passenger installations and configurations (install, remove, or check status)

bash
bolt-cli manage-my-apache-mod-passenger [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-my-apache-module ​

Manage MyApache Module configuration (enable or disable a module)

bash
bolt-cli manage-my-apache-module [--module [MODULE]] [--action [ACTION]]

Options:

  • --module=<value> – Module name to enable or disable
  • --action=<value> – Action to perform (enable, disable)

bolt-cli manage-nftable ​

Manage Nftables installations and configurations (install, remove, or check status)

bash
bolt-cli manage-nftable [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-php ​

Manage PHP versions for AdminBolt (install, remove, or check status)

bash
bolt-cli manage-php [--php-version [PHP-VERSION]] [--action [ACTION]]

Options:

  • --php-version=<value>
  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-php-default-profile ​

Manage the default PHP versions profiles

bash
bolt-cli manage-php-default-profile [--php-version [PHP-VERSION]] [--action [ACTION]]

Options:

  • --php-version=<value> – The PHP version to manage
  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-postfix ​

Manage Postfix installations and configurations (install, remove, or check status)

bash
bolt-cli manage-postfix [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-postfix-profiles ​

Apply default postfix settings

bash
bolt-cli manage-postfix-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-powerdns ​

Manage PowerDNS installations and configurations (install, remove, or check status)

bash
bolt-cli manage-powerdns [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-redis ​

Manage Redis installations and configurations (install, remove, or check status)

bash
bolt-cli manage-redis [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-redis-profiles ​

Apply default Redis settings

bash
bolt-cli manage-redis-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-rspamd ​

Manage Rspamd installations and configurations (install, remove, or check status)

bash
bolt-cli manage-rspamd [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-rspamd-profiles ​

Apply default Rspamd settings

bash
bolt-cli manage-rspamd-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-spamassassin ​

Manage SpamAssassin installations and configurations (install, remove, or check status)

bash
bolt-cli manage-spamassassin [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-spamassassin-profiles ​

Apply default SpamAssassin settings

bash
bolt-cli manage-spamassassin-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-sshd ​

Manage SSHD installations and configurations (install, remove, or check status)

bash
bolt-cli manage-sshd [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-sshd-profiles ​

Apply default SSHD settings

bash
bolt-cli manage-sshd-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-system-email-account ​

Manage system email accounts (install or remove)

bash
bolt-cli manage-system-email-account [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

bolt-cli manage-vsftpd ​

Manage Vsftpd installations and configurations (install, remove, or check status)

bash
bolt-cli manage-vsftpd [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install, remove, status)

bolt-cli manage-vsftpd-profiles ​

Apply default vsftpd settings

bash
bolt-cli manage-vsftpd-profiles [--action [ACTION]]

Options:

  • --action=<value> – Action to perform (install or remove)

Setup & internal ​

Internal commands

These commands are used by the installer and upgrade pipeline. Running them manually on a production system may break the installation.

bolt-cli add-bolt-greeting-message ​

Add Bolt greeting message to the /etc/profile file

bash
bolt-cli add-bolt-greeting-message

bolt-cli install-database ​

Install database of the AdminBolt

bash
bolt-cli install-database [--db-path [DB-PATH]] [--app-env [APP-ENV]]

Options:

  • --db-path=<value>
  • --app-env=<value>

bolt-cli key-generate ​

Set the application key

bash
bolt-cli key-generate

bolt-cli local-api-database ​

Validate integrated-app SSO token and output database credentials for local API/apps

bash
bolt-cli local-api-database [--token [TOKEN]] [--database [DATABASE]] [--app [APP]] [--format [FORMAT]]

Options:

  • --token=<value> – SSO token
  • --database=<value> – Database key (panel, mailserver, powerdns, all)
  • --app=<value> – App name (must match token)
  • --format=<value> – Output format: json or env

bolt-cli local-api-list-domains ​

List domains from the local API

bash
bolt-cli local-api-list-domains

bolt-cli mark-panel-as-installed ​

Mark the control panel as installed

bash
bolt-cli mark-panel-as-installed

bolt-cli post-install-check ​

Post installation check of Adminbolt

bash
bolt-cli post-install-check

bolt-cli proccess-killer ​

Kill the process listening on the given port (Linux)

bash
bolt-cli proccess-killer <port>

Arguments:

  • port (required) – The port number (e.g. 80)

bolt-cli refresh-installed-php ​

Refresh the list of installed PHP versions in the system.

bash
bolt-cli refresh-installed-php

bolt-cli run-base-setup ​

Run base setup for the panel

bash
bolt-cli run-base-setup

bolt-cli run-hostname-ssl ​

Install SSL certificate for the hostname

bash
bolt-cli run-hostname-ssl

bolt-cli run-upgrade-steps ​

Run any pending one-shot upgrade steps registered under App\UpgradeSteps.

bash
bolt-cli run-upgrade-steps [--retry-failed] [--only [ONLY]] [--list]

Options:

  • --retry-failed – Re-run steps currently in "failed" state
  • --only=<value> – Only run steps whose id() matches one of the given values
  • --list – List discovered steps and their current status without running anything

bolt-cli set-ini-settings ​

Set INI settings in bolt.ini.php

bash
bolt-cli set-ini-settings <key> <value>

Arguments:

  • key (required)
  • value (required)

bolt-cli setup-cron-jobs ​

Setup Cron Job Commands

bash
bolt-cli setup-cron-jobs

bolt-cli setup-firewall ​

Setup firewall

bash
bolt-cli setup-firewall

bolt-cli setup-web-panel-port ​

Change the web panel port to a new value

bash
bolt-cli setup-web-panel-port [--port [PORT]]

Options:

  • --port=<value> – Web panel port (default: 8443)

bolt-cli softaculous-cronjob ​

Add Softaculous crontab

bash
bolt-cli softaculous-cronjob [--action [ACTION]]

Options:

  • --action=<value>