The sahaab command line: every command explained

For server administrators · Updated 2026-10-29

On this page
  1. Commands for administrators
  2. Examples
  3. Internal commands
  4. Good to know
  5. Common questions

The control panel installs a command-line tool, sahaab, on the server. Run it as root over SSH (or in the Terminal). It is mostly used to regain access and to fix problems when the web interface cannot help.

Commands for administrators

CommandWhat it does
sahaab passwd <username> <new-password>Sets a new panel sign-in password for a user, for example the administrator
sahaab 2fa:disable <username>Turns off two-factor sign-in for a user who lost their phone, and deletes their recovery codes
sahaab admin:allow-ip <ip>Adds an IP address to the list of addresses allowed to open the admin panel
sahaab admin:allow-ip clearRemoves the admin panel IP restriction completely
sahaab dns:nameserversCreates the A records the server needs to act as its own nameservers (ns1, ns2 and the hostname)
`sahaab transfer:add <host> [--port=22] [--auth=key\password]`Adds a source server to the Transfer Tool and starts listing its accounts
sahaab jobs:runProcesses all queued tasks once and exits
sahaab migrateApplies pending updates of the panel's database
sahaab versionShows the installed version

Run sahaab without a command to see the list of commands.

Examples

Reset the administrator's password (the default administrator username is root):

sahaab passwd root 'N3w-Strong-Pass'

The password needs at least 8 characters and at least 3 of: lowercase letters, uppercase letters, digits, symbols. Put it in single quotes so the shell does not change special characters.

Let yourself into an admin panel limited to certain IP addresses:

sahaab admin:allow-ip 203.0.113.25

Add a transfer source with a password (the password is read from an environment variable, never from the command line):

SAHAAB_TRANSFER_PASSWORD='old-root-password' sahaab transfer:add 198.51.100.20 --auth=password

Internal commands

The installer, updates and the certificate tool also use setup, acme:dns, acme:http, acme:migrate, repo:setup, os:check and mail:sni. You do not need to run them by hand.

Good to know

  • The commands change the panel's database directly; they do not need the agent to run, except that transfer:add and dns:nameservers queue tasks for it.
  • sahaab dns:nameservers does not create a zone for a domain whose DNS is already hosted elsewhere. It prints the records to add at that DNS provider instead.

Common questions

"command not found: sahaab" — what now?

Run it with its full path: php /usr/local/sahaab/bin/sahaab version.

Was this article helpful?

Still stuck?

Ask the AI about your exact situation — it answers from this knowledge base — or contact us.