CLI command reference

Generated reference for every supported Constal CLI command, argument, option, and corresponding public Platform API operation.

This reference is generated directly from the command registry used by constal --help. A documented command that is absent from the executable, or an executable command missing here, fails the documentation build. Commands use only public /v1 Platform API endpoints.

Global overrides are available on every command. CONSTAL_API_KEY, CONSTAL_PLATFORM_URL, CONSTAL_NAMESPACE, and CONSTAL_TENANT override stored configuration. Prefer --output json or jsonl for automation and preserve caller-stable event identifiers when retrying an uncertain mutation.

Command index

GroupCommands
authauth login, auth logout, auth status
contextcontext show, context use
deploymentsdeployments create, deployments get
agentsagents list, agents get
runsruns start, runs session, runs events, runs workflow, runs get, runs detail, runs journal, runs journal-window, runs waits, runs resolve, runs steer, runs stream, runs delete-session, runs deletion, runs pause, runs resume, runs cancel, runs interrupt, runs policy, runs rebind, runs truncate, runs branch
resourcesresources list, resources create, resources get, resources delete, resources control, resources enable, resources disable
bindingsbindings list, bindings create, bindings get, bindings delete, bindings promote, bindings enable, bindings disable, bindings revoke
credentialscredentials providers catalog, credentials providers list, credentials providers get, credentials providers install, credentials list, credentials get, credentials create, credentials version, credentials activate, credentials rotate, credentials authorize, credentials revoke, credentials consumers, credentials uses, credentials events
channelschannels list, channels get, channels send, channels message, channels events, channels alarm, channels alarm-get, channels alarm-cancel
policiespolicies evaluate
analyticsanalytics summary, analytics live, analytics dashboard, analytics query, analytics export, analytics export-get
memorymemory stores list, memory stores create, memory stores get, memory stores delete, memory list, memory create, memory get, memory delete
customerscustomers list, customers get, customers put, customers enable, customers disable, customers map, customers unmap, customers bind-policy, customers unbind-policy
artifactsartifacts get
exportsexports get
anchorsanchors get
stagesstages get, stages recover
tablestables get, tables export-get

Auth

auth login

Save a Constal API key using a hidden prompt, stdin, or a file.

text
constal auth login
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--token-stdinRead the API key from stdin.
--token-file <FILE>Read the API key from a file.
sh
printf '%s' "$CONSTAL_API_KEY" | constal auth login --token-stdin

auth logout

Remove the locally stored Constal API key.

text
constal auth logout
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

auth status

Check whether the current credentials can read the selected namespace.

text
constal auth status
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

Context

context show

Show the effective origin, tenant restriction, namespace, and credential source.

text
constal context show
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

context use

Persist the default origin, tenant restriction, or namespace.

text
constal context use
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Set the Platform API origin.
--namespace <NAME>Set the default namespace.
--tenant <NAME>Set the tenant restriction.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--clear-tenantRemove the tenant restriction.
sh
constal context use --namespace production
sh
constal context use --tenant acme

Deployments

deployments create

Upload an immutable executable ZIP or tar.gz package.

text
constal deployments create <archive>
ArgumentMeaning
archivePath to the ZIP or tar.gz package.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--idempotency-key <KEY>Override the content-derived deployment key.
sh
constal deployments create support-agent.zip

deployments get

Read deployment build and publication state.

text
constal deployments get <deployment>
ArgumentMeaning
deploymentDeployment UUID.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

Agents

agents list

List deployed Agents in the namespace.

text
constal agents list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

agents get

Read one deployed Agent.

text
constal agents get <agent>
ArgumentMeaning
agentAgent id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

Runs

runs start

Start an Agent Run in a stable session.

text
constal runs start <agent> <session>
ArgumentMeaning
agentAgent id.
sessionStable session id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--data <JSON or @FILE or @->Agent input JSON.
--deliver <MODE>Queue work or drive it live. Values: queue, live.
--event-id <ID>Use a caller-stable idempotency event identifier.
sh
constal runs start support customer-42 --data @request.json --deliver live

runs session

Read bounded authoritative session state.

text
constal runs session <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--limit <COUNT>Bound the number of returned records.

runs events

Page accepted session events and ledger history.

text
constal runs events <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.
--limit <COUNT>Bound the number of returned records.

runs workflow

Read the authoritative current workflow view.

text
constal runs workflow <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

runs get

Read one authoritative Run.

text
constal runs get <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

runs detail

Read bounded Run, fact, wait, steer, and journal detail.

text
constal runs detail <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--limit <COUNT>Bound the number of returned records.

runs journal

Read the cryptographically rooted Run journal.

text
constal runs journal <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.
--limit <COUNT>Bound the number of returned records.

runs journal-window

Page an operator-oriented Run journal window.

text
constal runs journal-window <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.
--before <CURSOR>Read before a returned cursor.
--limit <COUNT>Bound the number of returned records.

runs waits

List open durable waits for a session.

text
constal runs waits <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

runs resolve

Resolve one durable wait with a schema-checked value.

text
constal runs resolve <agent> <session> <promise>
ArgumentMeaning
agentAgent id.
sessionSession id.
promiseWait promise id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--value <JSON or @FILE or @->Resolution value.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs steer

Append authenticated guidance to a session.

text
constal runs steer <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--text <TEXT>Guidance text. Required.
--data <JSON or @FILE or @->Optional structured guidance.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs stream

Stream committed Run frames over Server-Sent Events.

text
constal runs stream <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--run <RUN>Run id to stream. Required.

runs delete-session

Delete a session asynchronously and preserve a bounded tombstone.

text
constal runs delete-session <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs deletion

Read asynchronous session-deletion progress.

text
constal runs deletion <agent> <session>
ArgumentMeaning
agentAgent id.
sessionSession id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

runs pause

Pause one exact Run.

text
constal runs pause <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs resume

Resume one exact Run.

text
constal runs resume <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs cancel

Cancel one exact Run.

text
constal runs cancel <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs interrupt

Interrupt a Run at a safe point or abort active work.

text
constal runs interrupt <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--mode <MODE>Use safe-point or abort. Required. Values: safe-point, abort.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs policy

Apply an idempotent policy control to one Run.

text
constal runs policy <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs rebind

Apply an idempotent rebind control to one Run.

text
constal runs rebind <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs truncate

Apply an idempotent truncate control to one Run.

text
constal runs truncate <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

runs branch

Apply an idempotent branch control to one Run.

text
constal runs branch <agent> <session> <run>
ArgumentMeaning
agentAgent id.
sessionSession id.
runRun id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

Resources

resources list

List configured Resources, optionally by kind.

text
constal resources list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--kind <KIND>Filter by Resource kind.

resources create

Create a configured Resource from a JSON definition.

text
constal resources create
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

resources get

Read one tenant-managed Resource.

text
constal resources get <kind> <id>
ArgumentMeaning
kindResource kind.
idResource id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

resources delete

Delete one tenant-managed Resource.

text
constal resources delete <kind> <id>
ArgumentMeaning
kindResource kind.
idResource id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

resources control

Read one Resource control head.

text
constal resources control <kind> <id>
ArgumentMeaning
kindResource kind.
idResource id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

resources enable

Enable a tenant-managed Resource.

text
constal resources enable <kind> <id>
ArgumentMeaning
kindResource kind.
idResource id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

resources disable

Disable a tenant-managed Resource.

text
constal resources disable <kind> <id>
ArgumentMeaning
kindResource kind.
idResource id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

Bindings

bindings list

List scoped Resource and Credential assignments.

text
constal bindings list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

bindings create

Create a scoped assignment from a JSON definition.

text
constal bindings create
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

bindings get

Read one scoped assignment.

text
constal bindings get <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

bindings delete

Delete one scoped assignment idempotently.

text
constal bindings delete <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.

bindings promote

Promote a binding when its current revision still matches.

text
constal bindings promote <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

bindings enable

Enable one scoped assignment.

text
constal bindings enable <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

bindings disable

Disable one scoped assignment.

text
constal bindings disable <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

bindings revoke

Revoke one scoped assignment.

text
constal bindings revoke <binding>
ArgumentMeaning
bindingBinding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

Credentials

credentials providers catalog

List Credential Provider packages visible to the tenant.

text
constal credentials providers catalog
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials providers list

List installed Credential Providers.

text
constal credentials providers list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials providers get

Read one installed Credential Provider.

text
constal credentials providers get <provider>
ArgumentMeaning
providerProvider id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials providers install

Install a catalog Credential Provider package.

text
constal credentials providers install
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <SOURCE>Read protected setup JSON from @FILE or @-.
sh
constal credentials providers install --body @provider-setup.json

credentials list

List Credentials without returning material.

text
constal credentials list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials get

Read authoritative Credential metadata.

text
constal credentials get <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials create

Create, mint, or begin authorization for a Credential.

text
constal credentials create <credential>
ArgumentMeaning
credentialNew Credential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--provider <CRN>Installed Credential Provider CRN. Required.
--configuration <JSON or @FILE>Provider-defined non-secret configuration.
--material-file <FILE>Read imported secret material from a file.
--material-stdinRead imported secret material from stdin.
--policies <JSON or @FILE>Optional Policy CRN array.

credentials version

Add imported material as a scheduled Credential version.

text
constal credentials version <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--material-file <FILE>Read secret material from a file.
--material-stdinRead secret material from stdin.

credentials activate

Activate a Credential lifecycle operation.

text
constal credentials activate <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

credentials rotate

Rotate a Credential lifecycle operation.

text
constal credentials rotate <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

credentials authorize

Authorize a Credential lifecycle operation.

text
constal credentials authorize <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

credentials revoke

Revoke a Credential lifecycle operation.

text
constal credentials revoke <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

credentials consumers

List bounded Credential consumers.

text
constal credentials consumers <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

credentials uses

List bounded Credential uses.

text
constal credentials uses <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.

credentials events

List bounded Credential events.

text
constal credentials events <credential>
ArgumentMeaning
credentialCredential id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.

Channels

channels list

List deployed Channels.

text
constal channels list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

channels get

Read one deployed Channel.

text
constal channels get <channel>
ArgumentMeaning
channelChannel id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

channels send

Send one outbound Channel message.

text
constal channels send <channel>
ArgumentMeaning
channelChannel id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

channels message

Read one outbound delivery receipt.

text
constal channels message <channel> <message>
ArgumentMeaning
channelChannel id.
messageMessage id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

channels events

Read bounded Channel events.

text
constal channels events <channel>
ArgumentMeaning
channelChannel id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--after <CURSOR>Continue after a returned cursor.
--limit <COUNT>Bound the number of returned records.

channels alarm

Schedule a Channel alarm.

text
constal channels alarm <channel>
ArgumentMeaning
channelChannel id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

channels alarm-get

Read one Channel alarm.

text
constal channels alarm-get <channel> <alarm>
ArgumentMeaning
channelChannel id.
alarmAlarm id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

channels alarm-cancel

Cancel one Channel alarm.

text
constal channels alarm-cancel <channel> <alarm>
ArgumentMeaning
channelChannel id.
alarmAlarm id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

Policies

policies evaluate

Evaluate a deployed Policy against a normalized test input.

text
constal policies evaluate <policy>
ArgumentMeaning
policyPolicy id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

Analytics

analytics summary

Read a bounded recent analytics summary.

text
constal analytics summary
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

analytics live

Query live analytics data.

text
constal analytics live
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

analytics dashboard

Query dashboard analytics data.

text
constal analytics dashboard
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

analytics query

Query query analytics data.

text
constal analytics query
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

analytics export

Create export analytics data.

text
constal analytics export
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

analytics export-get

Download one namespace-owned analytics export.

text
constal analytics export-get <ref>
ArgumentMeaning
refExport artifact hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--out <FILE>Write the binary response to a file instead of stdout.
--quietSuppress the file-write status message.

Memory

memory stores list

List configured Memory Stores.

text
constal memory stores list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

memory stores create

Create a Memory Store Resource.

text
constal memory stores create
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

memory stores get

Read one Memory Store.

text
constal memory stores get <id>
ArgumentMeaning
idMemory Store id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

memory stores delete

Delete one Memory Store.

text
constal memory stores delete <id>
ArgumentMeaning
idMemory Store id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

memory list

List configured Memory Resources.

text
constal memory list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

memory create

Create a Memory Resource.

text
constal memory create
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

memory get

Read one Memory Resource.

text
constal memory get <id>
ArgumentMeaning
idMemory id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

memory delete

Delete one Memory Resource.

text
constal memory delete <id>
ArgumentMeaning
idMemory id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

Customers

customers list

List downstream customers.

text
constal customers list
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

customers get

Read one downstream customer.

text
constal customers get <customer>
ArgumentMeaning
customerCustomer id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

customers put

Create or update a downstream customer.

text
constal customers put <customer>
ArgumentMeaning
customerCustomer id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

customers enable

Enable a downstream customer.

text
constal customers enable <customer>
ArgumentMeaning
customerCustomer id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

customers disable

Disable a downstream customer.

text
constal customers disable <customer>
ArgumentMeaning
customerCustomer id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--event-id <ID>Use a caller-stable idempotency event identifier.
--reason <TEXT>Record an optional operator reason.

customers map

map for a downstream customer.

text
constal customers map <customer> <binding>
ArgumentMeaning
customerCustomer id.
bindingMapping or binding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

customers unmap

unmap for a downstream customer.

text
constal customers unmap <customer> <binding>
ArgumentMeaning
customerCustomer id.
bindingMapping or binding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

customers bind-policy

bind policy for a downstream customer.

text
constal customers bind-policy <customer> <binding>
ArgumentMeaning
customerCustomer id.
bindingMapping or binding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

customers unbind-policy

unbind policy for a downstream customer.

text
constal customers unbind-policy <customer> <binding>
ArgumentMeaning
customerCustomer id.
bindingMapping or binding id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.
--event-id <ID>Use a caller-stable idempotency event identifier.

Artifacts

artifacts get

Download an authorized content-addressed artifact.

text
constal artifacts get <ref>
ArgumentMeaning
refArtifact hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--out <FILE>Write the binary response to a file instead of stdout.
--quietSuppress the file-write status message.

Exports

exports get

Download a redacted durable export.

text
constal exports get <ref>
ArgumentMeaning
refExport hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--out <FILE>Write the binary response to a file instead of stdout.
--quietSuppress the file-write status message.

Anchors

anchors get

Download an authorized customer audit anchor.

text
constal anchors get <ref>
ArgumentMeaning
refAnchor hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--out <FILE>Write the binary response to a file instead of stdout.
--quietSuppress the file-write status message.

Stages

stages get

Inspect one map/reduce stage.

text
constal stages get <stage>
ArgumentMeaning
stageStage hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.

stages recover

Request authorized stage recovery.

text
constal stages recover <stage>
ArgumentMeaning
stageStage hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--body <JSON or @FILE or @->Read the JSON request body inline, from a file, or from stdin.

Tables

tables get

Read a table branch head and state.

text
constal tables get <table>
ArgumentMeaning
tableTable id.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--branch <NAME>Table branch; defaults to main.

tables export-get

Read an exact table catalog commit, export, or intent.

text
constal tables export-get <table> <branch> <sequence> <hash>
ArgumentMeaning
tableTable id.
branchBranch name.
sequenceCommit sequence.
hashCommit hash.
OptionMeaning
--helpShow command help.
--versionShow the CLI version.
--origin <URL>Override the configured Platform API origin.
--namespace <NAME>Override the configured namespace.
--tenant <NAME>Restrict authentication to this tenant.
--output <FORMAT>Render table, json, or jsonl output. Values: table, json, jsonl.
--out <FILE>Write the binary response to a file instead of stdout.
--quietSuppress the file-write status message.