@composal/cli
v1.17.91
Published
Composal CLI for Verify, hosted apps, deployments, secrets, and agent setup
Readme
com brings Composal to your terminal and coding agents. Verify real user journeys,
deploy applications, manage secrets, and connect your agent to the same tools you
use to ship.
Install
With Node.js 18 or newer:
npm install -g @composal/cliPrefer the standalone installer? No Node.js required:
curl -fsSL https://dl.composal.ai/install.sh | shBoth options install the lightweight com product CLI. Git source checkout and
runner execution belong to the separate vex CLI.
Supported platforms are macOS Apple Silicon and Linux x64 with glibc. On Windows, use an x64 WSL distribution.
You can also run without a global installation:
npx @composal/cli --helpFor a project, install with npm install --save-dev @composal/cli and run npx com.
Pin a version with npm install -g @composal/cli@<version>.
Get started
com login
com whoami
com --helpFor agents and headless automation, start with the guide embedded in your CLI:
com agent-guide
com auth check --json
com schema verify sweeps run
com --agent app list --org <org>--agent returns versioned JSON receipts without prompts. --json preserves
existing success payloads and returns structured failures. Read the embedded
guide for authentication, operation IDs, idempotent retries, and full workflows.
Follow the quickstart to connect your account and run your first commands.
What you can do
| | From your terminal | | --- | --- | | Verify | Test real browser journeys and inspect screenshots, recordings, and traces. | | Ship applications | Deploy apps, manage services and preview environments, and inspect logs. | | Manage secrets | Store and retrieve secrets, or run commands with secrets injected into their environment. | | Equip your agents | Set up Composal skills and MCP tools for your coding agent. |
Explore commands with com verify --help, com deploy --help, and
com secrets --help. The CLI reference covers the
full command set.
Connect your coding agent
For Codex, install the compact Composal skill into your project:
com skills install --targets codex --dry-run --json
com skills install --targets codex --jsonRun com skills setup for the same installation and com skills list for workflow references and com skills install --help for
other agents. The same compact guide is at composal.ai/agent.md.
Use com skills setup --targets codex --mcp to install the same single skill and configure MCP.
Add --with deploy to also install the optional deployment skill.
Stay up to date
For a global npm installation:
npm install -g @composal/cli@latestFor a project installation, run npm install --save-dev @composal/cli@latest.
For the standalone installer:
com updateExplore Composal
- Quickstart — install, sign in, and get started.
- CLI reference — commands and examples.
- Verify — browser testing for your application.
- Hosting — deploy and operate your apps.
- Agent setup — bring Composal to your coding workflow.
Found an issue or have an idea? Let us know.
