@composal/cli

中文文档
1.17.108发布于 2026/11/06Apache-2.0零依赖近 30 天下载 4270

Composal CLI for Verify, hosted apps, deployments, secrets, and agent setup

原始使用文档
文档目录6 节
  1. Install
  2. Get started
  3. What you can do
  4. Connect your coding agent
  5. Stay up to date
  6. Explore Composal
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 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 --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

For 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
VerifyTest real browser journeys and inspect screenshots, recordings, and traces.
Ship applicationsDeploy apps, manage services and preview environments, and inspect logs.
Manage secretsStore and retrieve secrets, or run commands with secrets injected into their environment.
Equip your agentsSet 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 --json

Run 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.com/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@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.

版本与发布记录

@composal/cli 共发布 29 个版本,首次发布于 2026/10/06;过去 12 个月发布了 29 个版本。

版本发布日期距今
1.17.108latest2026/11/064 天前
1.17.1062026/11/037 天前
1.17.1052026/10/3011 天前
1.17.1042026/10/2912 天前
1.17.1022026/10/2813 天前
1.17.1012026/10/2813 天前

关于 @composal/cli 的常见问题

@composal/cli 是什么?

Composal CLI for Verify, hosted apps, deployments, secrets, and agent setup

如何安装 @composal/cli?

在项目目录运行 npm install @composal/cli,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 com,可以用 npx com 直接运行。

@composal/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/composal__cli 是否存在。

@composal/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@composal/cli 可以商用吗?

@composal/cli 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@composal/cli 的下载量有多少?

根据 npm 官方下载统计,@composal/cli 在 2026/10/11 – 2026/11/09 这 30 天内被下载 4,270 次,日均约 142 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@composal/cli 还在维护吗?

最新版本 1.17.108 发布于 2026/11/06(4 天前);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/10/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。