Skip to content

Reference

CLI reference

Every `hypno` command — status, rotate, doctor, backups, firewall, reset and more.

Updated Edit this page on GitHub

The hypno CLI runs on the VPS as root (it authenticates with the root-only CLI token). On the development preview it is bun scripts/hypno.mjs <command>.

hypno status [--json]         Panel, tunnel, proxy, DB and Docker health
hypno url                     Print the current access URL path
hypno rotate [--custom <slug>] [--yes]
                              Rotate the access URL (random 32 chars, or custom slug 16-64)
hypno credentials             Show admin email(s) — never passwords
hypno reset emailpass         Interactive reset: new email + password
hypno reset password [--random | --password-stdin]
                              Reset only the password
hypno reset email             Reset only the admin email
hypno 2fa disable             Disable 2FA for an admin (typed email confirmation)
hypno sessions list|revoke-all
hypno start | stop | restart  Panel service control (systemd)
hypno logs [-n 200]           Panel log tail
hypno tunnel status|restart   Relay tunnel state, latency, server ID, access URL
hypno firewall status [--ruleset]
hypno backup now|list|verify <id>
hypno update [--check]        Channel + real GitHub release check
hypno doctor [--json]         PASS/FAIL diagnostics with fix suggestions
hypno config get [key] | set <key> <value>
hypno version
hypno uninstall               Typed confirmation (REMOVE / REMOVE-DATA)
hypno completion bash|zsh|fish

Examples

$ hypno doctor
PASS  Panel API — HTTP 200          PASS  Relay tunnel — connected
PASS  Data directory — present       PASS  Disk space — root usage 46%
PASS  Secret key — present           PASS  Clock skew — 10s
PASS  CLI token — present            FAIL  KVM virtualization — detected: docker
PASS  Backups dir — present
PASS  secret.key mode — 0600
9/10 checks passed

Every mutating CLI action is audit-logged with source local-cli.