CLI reference
This section will document every top-level hiveloom subcommand with flags,
arguments, and a minimal worked example. It’s seeded with the groupings below;
the individual pages fill in during the spec 008 follow-up work.
Command groups
Service & operator
serve, health, status, doctor, logs, tail, top, tls
Tenants & identity
tenant, auth, mcp-identity
Agents
agent, capability, credential, chat, apply
Scheduling & events
schedule, event
Backup & upgrade
backup, upgrade, rollback, compaction-log
Global flags
Available on most commands:
| Flag | Description |
|---|---|
--tenant <slug> | Tenant (default: default) |
--endpoint <url> | API endpoint (default: auto-detected) |
--token <token> | Bearer token for remote access |
--json | Output as JSON instead of a human table |
While the per-command pages are being written
In the meantime, hiveloom <command> --help prints the same content that will
appear on the per-command pages.
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>.