Skip to Content
CLI referenceOverview

CLI reference

One page per top-level hiveloom subcommand. Pick a group below; each card goes to the per-command reference. hiveloom <command> --help prints the same content from the binary.

Service & operator

Tenants & identity

Agents

Scheduling & events

Backup, upgrade, observability

Global flags

Available on most commands:

FlagDescription
--tenant <slug>Tenant (default: default)
--endpoint <url>API endpoint (default: auto-detected)
--token <token>Bearer token for remote access
--jsonOutput as JSON instead of a human table

Secrets contract

Secrets are never passed as CLI arguments. All credential-accepting commands take:

  • --from-env VAR — read from an environment variable, or
  • --from-file PATH — read from a file, or
  • stdin via echo "secret" | hiveloom <command>.
Last updated on