Constal CLI
Operate deployments, Agents, Runs, Resources, Credentials, Channels, Policies, Memory, and analytics from a terminal.
The constal command is a task-oriented client for the public Platform API. It packages and deploys executable code, invokes Agents, controls Runs, manages Resources and Credentials, and retrieves operational evidence. It does not replace @constal/sdk: the SDK authors code that executes inside Constal; the CLI operates that code from outside the runtime.
Choose the right interface
| Need | Interface |
|---|---|
| Author an Agent, Channel, Auth Provider, Policy, or Credential Provider | @constal/sdk |
| Perform an interactive operational task | Console or constal CLI |
| Automate a repeatable operational task | CLI with --output json, or the Platform API |
| Integrate Constal into another application | Platform API |
Availability and installation
Install the versioned @constal/cli package from npm. It exposes the constal executable:
npm install --global @constal/cli
constal --versionContinue with Install and configure the CLI, Use the CLI safely, and the generated command reference. Product sections contain focused CLI guides that explain which commands belong to each workflow.