Commands
Every menu action is a subcommand. All require root except --help, --version, env and completion.
Global flags
| Flag | Effect |
|---|---|
--debug | verbose logging; external command output shown on the terminal instead of hidden behind spinners |
--log-file PATH | log file (default /var/log/nomctl.log) |
--skip-preflight | skip the CPU/RAM/NTP/Internet checks |
Node lifecycle
| Command | Notes |
|---|---|
nomctl deploy [--repo URL] [--branch NAME] | Deploy |
nomctl start / stop / restart | Service control |
nomctl logs [-f] [-n LINES] | last 20 lines, or follow |
nomctl resync | wipe chain data, keep wallet and config |
nomctl backup [--max-backups N] [--cadence DAYS] [--hour HOUR] [--schedule] | Backups |
nomctl restore [--file FILE] | picker when --file is omitted |
nomctl backup wallet [--output DIR] [--no-encrypt] | wallet and config backup, age-encrypted; passphrase prompted or NOMCTL_WALLET_PASSPHRASE |
nomctl restore wallet FILE [--restart] | verifies the archived key against its config before replacing anything |
nomctl bootstrap [URL] [--discard] | Bootstrap: verified snapshot instead of syncing from genesis |
nomctl analytics install | Analytics stack |
nomctl upgrade [--check] [--version TAG] [--rollback] | Upgrading |
config.json
| Command | Notes |
|---|---|
nomctl config show [--show-secrets] | config.json editor |
nomctl config get KEY | |
nomctl config set KEY VALUE [--restart] [--force] | validated; previous file backed up |
nomctl config unset KEY [--restart] | back to the default |
nomctl config edit [--restart] | $EDITOR, validated before install |
Pillar
| Command | Notes |
|---|---|
nomctl pillar deploy [--yes] [--password P] | Deploy a Pillar: official go-zenon master + service + producer key, in one |
nomctl pillar setup [--yes] [--password P] (or NOMCTL_PRODUCER_PASSWORD) | Pillar producer: create or configure the producer key, write config.json, restart the node |
nomctl pillar status [--show-password] | producer address, key file, which Pillar uses it |
Orchestrator
| Command | Notes |
|---|---|
nomctl orchestrator status | refuses when the unit is not installed |
nomctl orchestrator logs [-f] [-n 20] | |
nomctl orchestrator hard-reset | Orchestrator: stop, delete queues/ and events/, start |
Observability
| Command | Notes |
|---|---|
nomctl status [--json] [--wait 2s] [--no-update-check] | one-screen summary, with update lines when something is newer |
nomctl top [--interval 2s] [--no-update-check] | live dashboard, q to quit |
nomctl support-bundle [--watch] [--since "12 hours ago"] [--output DIR] [--poll 10s] [--timeout 0] | Support bundle |
Alerts
| Command | Notes |
|---|---|
nomctl alerts setup [--code CODE] [--name NAME] [--relay URL] [--accept-privacy-notice] | shows the privacy notice, pairs and starts the service |
nomctl alerts status | pairing, service, per-alert state |
nomctl alerts list | alerts with thresholds |
nomctl alerts enable ALERT / disable ALERT | |
nomctl alerts set ALERT.KEY VALUE | thresholds, e.g. disk_low.min_free_gb 20; also pillar.name NAME |
nomctl alerts test | send a test message |
nomctl alerts unpair [--force] | |
nomctl alerts run | the daemon; used by nomctl-alerts.service |
Other
| Command | Notes |
|---|---|
nomctl | the menu |
nomctl env | every NOMCTL_* variable with its default |
nomctl completion bash|zsh|fish | shell completion |
nomctl --version | version, commit, build date, platform |