crabbox/docs/commands/admin.md
Peter Steinberger 237ef3a64d
Some checks are pending
CI / Go (push) Waiting to run
CI / Worker (push) Waiting to run
CI / Docs (push) Waiting to run
CI / Release Check (push) Waiting to run
Pages / Deploy docs (push) Waiting to run
docs: sync provider and vnc docs (#26)
2026-05-04 21:17:49 +01:00

1.3 KiB

admin

crabbox admin contains trusted operator controls for coordinator-backed leases.

crabbox admin leases
crabbox admin leases --state active --json
crabbox admin release blue-lobster
crabbox admin release blue-lobster --delete
crabbox admin delete cbx_... --force

Release/delete accept a canonical cbx_... ID or an active slug; use the canonical ID when an admin slug lookup is ambiguous. Add --json to print the updated lease record.

Admin commands require a configured coordinator and a separate admin bearer token stored as broker.adminToken or CRABBOX_COORDINATOR_ADMIN_TOKEN. The shared operator token is not enough for admin routes.

leases

List coordinator lease records.

Flags:

--state <state>     filter by active, released, expired, or failed
--owner <email>     filter by owner
--org <name>        filter by org
--limit <n>         default 100, maximum 500
--json              print JSON

release

Mark a lease released. Add --delete to delete the backing server while releasing.

Flags:

--id <lease-id-or-slug>
--delete
--json

delete

Delete the backing server for an active lease and mark it released. Requires --force.

Flags:

--id <lease-id-or-slug>
--force
--json

Related docs: