Skip to content

Latest commit

 

History

History
105 lines (75 loc) · 3.19 KB

README.md

File metadata and controls

105 lines (75 loc) · 3.19 KB
Composal silver foil sticker

Composal CLI

Verify changes. Ship apps. Equip your agents.

npm · GitHub · Documentation · Composal


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/cli

Prefer the standalone installer? No Node.js required:

curl -fsSL https://dl.composal.com/install.sh | sh

Both options install the com command. 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 --help

For 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 --help

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 skills and configure MCP together:

com setup --targets codex --mcp

Run com setup --help for other supported agents and setup options.

Stay up to date

For a global npm installation:

npm install -g @composal/cli@latest

For a project installation, run npm install --save-dev @composal/cli@latest.

For the standalone installer:

com update

Explore 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.