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

Start the HTTP service.serve Liveness + readiness probe.health Per-tenant runtime snapshot.status Self-diagnostic.doctor Recent agent activity.logs Live process / scheduler view.top Render the Caddyfile.tls

Tenants & identity

Create / list / delete tenants.tenant Bearer-token issuance.auth Per-client MCP credentials.mcp-identity

Agents

Create / edit / version agents.agent Attach skills + tool capabilities.capability Store provider keys.credential Stream a conversation.chat YAML-manifest apply.apply

Scheduling & events

Cron-driven agent runs.schedule Event-driven agent runs.event

Backup, upgrade, observability

Create / list / restore archives.backup In-place binary upgrade.upgrade Revert to the previous binary.rollback Token-budget audit trail.compaction-log

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