AiHummer docs
v1.0.x
RU EN

CLI Reference

v1.0.x · updated 2026-06-26

The aihummer command-line tool manages a host-native install: it installs and updates the gateway, controls the systemd services, runs diagnostics, handles backups, and signs licenses. This page lists every command.

Commands

CommandWhat it does
up / installInstall (or bring up) the gateway and sidecars.
update [--check]Update to the latest release; --check only reports whether an update is available.
restartRestart the services.
stopStop the services.
logs [svc]Tail logs; pass a service name to filter.
statusShow service status.
doctorRun diagnostics / health checks.
backup [dir]Create a backup (optionally into a target directory).
restore <file>Restore from a backup file.
uninstall [flags]Remove the install (see flags below).
set-password / admin-passwordSet the local admin password.
license {keygen|sign|show}Manage licenses (generate key, sign, show).
loadtestRun a load test against the gateway.
plugin {init|validate|keygen|package|sign|publish}Plugin SDK: scaffold, validate, keys, package, sign and publish (private/public).
versionPrint the version.
helpShow help.

uninstall flags

FlagEffect
--purgeAlso remove data (full removal).
--yesSkip the confirmation prompt.
--no-backupDo not take a backup before removing.
--backup-dir <dir>Write the pre-uninstall backup to this directory.

Usage examples

Install and bring up

aihummer install
aihummer status

Update

# Only check whether a newer release exists
aihummer update --check

# Apply the update
aihummer update

Service control and logs

aihummer restart
aihummer logs                 # all services
aihummer logs gateway         # one service
aihummer stop

Diagnostics

aihummer doctor

Backup and restore

aihummer backup /var/backups/aihummer
aihummer restore /var/backups/aihummer/backup-2026-06-26.tar

[!TIP] Postgres is the source of truth, but your AIHUMMER_MASTER_KEY and the blob directory must be backed up separately — without the master key, encrypted secrets cannot be recovered.

Set the admin password

aihummer set-password

Licenses

aihummer license keygen        # generate a signing key
aihummer license sign          # sign a license
aihummer license show          # show the current license

Load test

aihummer loadtest

Plugins

aihummer plugin init <kind>            # scaffold a manifest (connector|service|openapi|mcp)
aihummer plugin validate manifest.json # validate a manifest against the contract
aihummer plugin keygen                 # ed25519 author key (.key + .pub)
aihummer plugin package ./my-plugin    # build a tarball + .sha256
aihummer plugin sign --key author.key --manifest ./my-plugin/manifest.json my-plugin-1.0.0.tar.gz

# Publish: privately (to your instance) or publicly (PR to the catalog)
aihummer plugin publish --private --instance https://host --token <admin> my-plugin-1.0.0.tar.gz
aihummer plugin publish --public --dir ./my-plugin --key author.key \
  --artifact-url https://you.example/my-plugin-1.0.0.tar.gz --publisher you \
  --description "..." --icon https://you.example/icon.svg

For the full SDK and both publishing modes see Plugin SDK and Publishing a plugin.

[!WARNING] aihummer uninstall --purge --yes removes data and skips the confirmation prompt. Make sure you have a verified backup first.

Where to next