Skip to Content

hiveloom tenant

Manages the tenant boundary inside a Hiveloom instance. Every agent, credential, and conversation lives inside exactly one tenant; the default tenant is named default and is the implicit target of every other CLI command unless you pass --tenant.

Synopsis

hiveloom tenant [GLOBAL FLAGS] <COMMAND>

Global flags

FlagDescription
--endpoint <URL>API endpoint. Auto-detected for a local instance.
--token <TOKEN>Bearer token for remote access.
--jsonJSON output instead of a table.

Subcommands

SubcommandPurpose
createCreate a new tenant.
listList all tenants.
showShow details for one tenant.
enableEnable a previously disabled tenant.
disableDisable a tenant (kept on disk; agents stop responding).
deleteSoft-delete a tenant (kept on disk for restore; agents stop).

Run hiveloom tenant <subcommand> --help for the per-subcommand argument list.

Examples

# Create a new tenant hiveloom tenant create --slug acme --name "Acme Corp" # List tenants in a human table hiveloom tenant list # Show details for one hiveloom tenant show acme --json | jq # Disable temporarily; can be re-enabled later hiveloom tenant disable acme # Soft-delete; stops responding but data is retained on disk hiveloom tenant delete acme

Behaviour notes

  • Tenant data lives in a per-tenant SQLite database under <data-dir>/tenants/<slug>.db. Soft-delete leaves the file intact.
  • Disabling a tenant rejects new admin and MCP requests for that tenant but does not destroy data.
  • Hard removal must be done by deleting the tenant DB file by hand after a soft-delete — there is no --force flag.