Skip to content

Operate Runtime and Console

Use this section after installation when you need to operate Caracal locally or understand which operator surface owns a task.

Caracal has two local operator surfaces:

SurfaceUse it forDo not use it for
caracalLocal stack lifecycle, readiness checks, local reset, token-injected process execution, and Console launch.Zones, applications, providers, resources, policies, audit, agents, delegation, or Control setup.
caracal console / caracal-consoleHuman management for zones, applications, providers, resources, policies, policy sets, authority sessions, Control, audit, request traces, agent sessions, delegation, and diagnostics.Starting or stopping the stack, purging local runtime state, or running workloads.

The runtime CLI stays small so lifecycle and workload execution do not depend on admin tokens, zone selection, or Control credentials. Product management belongs to the Console, Control API, or Admin SDK.

  1. Choose the Right Surface to confirm whether a task belongs in caracal, Console, Control API, or Admin SDK.
  2. Start and Check the Stack with caracal up and caracal status --ready.
  3. Use the Console to run guided setup and create the first runtime profile.
  4. Configure Workloads when a workload needs explicit profile, credential, or service endpoint settings.
  5. Run Workloads with caracal run -- <command>.
  6. Manage Product Objects for ongoing zone, application, provider, resource, policy, policy-set, and Control work.
  7. Inspect Diagnostics and Audit when debugging health, readiness, audit, or request decisions.
  8. Manage Agents and Delegation when workloads create agent sessions or delegation edges.
OutcomeSurface
Start, stop, check, or purge the local runtime stackcaracal
Launch the terminal Consolecaracal console
Run an agent process with scoped resource tokenscaracal run -- <command>
Create a zone, app, provider, resource, policy, or policy setConsole
Enable Control automationConsole control
Script management workflowsControl API or Admin SDK
Inspect audit events, request traces, diagnostics, agents, or delegationConsole

Start with Choose the Right Surface if you are deciding where an operation belongs. If you already know you need a local stack, go directly to Start and Check the Stack.