Skip to main content

CLI reference

The agent is the wakora binary. Run with no arguments it runs the agent loop (normally started by the service manager). The flags and subcommands below cover the operator paths.

Registration and identity​

CommandWhat it does
wakora --key <TEAM_KEY>Register this host, then run. Used once, the key is not stored. Over an identity this machine cannot decrypt (a copied disk) the old file is moved aside and the machine registers as a new host.
wakora --versionPrint the version and exit.
wakora --testDry run: collect and print, do not connect.
wakora doctorSelf-diagnostics in dependency order; each failure prints the next step.
wakora doctor --bundleAlso write a redacted support archive to /tmp.

Configuration​

CommandWhat it does
wakora --set <svc>.<key>=<value>Write a location override to wakora.conf and exit.
wakora --baselineRun in safe baseline mode (probes do not activate).
wakora --custom-metrics-port <port>Loopback port for app custom metrics (app.*).
wakora --otlp-port <port>Loopback OTLP receiver for APM spans.
wakora --otlp-bind <addr>Extra bind address for OTLP (for example a Docker bridge).

Secrets​

CommandWhat it does
wakora secret set <name> [--user U] [--priv]Store a credential encrypted on the host. Names are letters, digits, ., _, : and -, up to 128 characters.
wakora secret listList stored secret names (no values).
wakora secret rm <name>Remove a stored secret.

The password is read from a no-echo prompt, or from stdin for automation. --priv (SNMP v3) prompts for both the auth and the privacy passphrase.

Service management​

CommandWhat it does
wakora service installInstall and start the service (idempotent).
wakora service uninstallRemove the service.
wakora service start / stopStart or stop the service.

On Linux with systemd the unit is wakora-agent, managed with systemctl. service subcommands are the primary path on macOS (launchd) and Windows (SCM).

Updates​

CommandWhat it does
wakora --updateUpdate to the latest signed release and restart the service.
wakora --set agent.pin=rNPin this host to an exact release (converges up or down). Empty value unpins.

Removal​

CommandWhat it does
wakora uninstallDeregister, remove the service, wipe files, delete the binary. Asks for the hostname; --force skips the confirmation.

See Uninstalling for the console-side removal and the APM exception.

Files​

PathContents
/etc/wakora/identityUUID and per-server key (machine-bound ciphertext).
/etc/wakora/wakora.confOptional non-secret location overrides (INI).
/etc/wakora/secrets.confEncrypted local credentials.
/etc/wakora/pending-keyTransient: parked team key until registration succeeds.
/var/lib/wakora/Offline spool, provisioned APM artifacts, staged changes.
/var/log/wakora/agent.logAgent log (rotated).

On Windows these fold into %ProgramData%\Wakora.