Skip to content

Choose the Right Surface

Choose a surface from the outcome you need, not from where a similarly named object happens to appear.

You need toUseWhy
Start, stop, inspect, upgrade, or reset a local runtimecaracalThese operations concern local processes and storage.
Launch a command with scoped credentialscaracal runIt authenticates a Launcher workload and injects its configured bindings.
Admit, suspend, or remove a console usercaracal allowlistAccess is host-level auth configuration, not zone product state.
Create or change product objectsWeb consoleIt provides selected-zone context, validation, guided setup, and audited secret handling.
Investigate or intervene in live authorityWeb consoleSubjects, Authority records, Sessions, Delegations, Approvals, Audit, and Diagnostics are structured operator workflows.
Manage product state from CI or another trusted hostControl API or Admin SDKThese are authenticated automation surfaces.

The top-level runtime commands are lifecycle and launch commands:

up down status upgrade purge allowlist run web

web is a development launcher for the console UI and auth backend. It is not a product-management command. The packaged console already runs as part of caracal up and is opened in a browser at http://localhost:3001.

Do not look for top-level commands to create zones, policies, applications, resources, workloads, Sessions, Delegations, Approvals, or Control keys. Use the console for human work. Use the Admin SDK or Control API for automation.

Use the web console when a person needs to follow guided setup, review selected-zone validation, reveal a secret with an audit record, activate policy, inspect a trace, decide an eligible Approval, or intervene in a Session.

Use automation only from a trusted operator environment. The Admin SDK provides direct management APIs. The optional Control API provides zone-bound, scoped, replay-protected remote invocation. Neither surface starts Docker or launches workload processes.

Never give workload code root admin, Coordinator, Control, or secret-store credentials. Workloads authenticate with application, SDK, or Launcher workload credentials.

SymptomAction
A zone or policy command is absent from caracalOpen the web console; the absence is intentional.
A lifecycle command asks for a zone or admin tokenTreat it as a boundary violation.
CI needs repeatable configurationUse the Admin SDK or Control API, not browser scripting.
The console is unavailable but lifecycle must continueUse caracal status, down, or up; lifecycle does not depend on console access.

Start and Check the Stack.