@compozy/cli

中文文档
0.5.5发布于 2026/11/09MITES Module构建来源已验证近 30 天下载 5020

One complete environment to create, automate, and supervise agent work.

原始使用文档
文档目录24 节
  1. ✨ Highlights
  2. 📦 Installation
  3. 🔄 How It Works
  4. Daemon Runtime Model
  5. Task Schema v2
  6. ⚙️ Config Files
  7. Reusable Agents
  8. 🔌 Extensions
  9. Build one in three commands
  10. SDK support
  11. Extension CLI
  12. Learn more
  13. Build an app
  14. 🚀 Quick Start
  15. 🧩 Skills
  16. 🧠 Workflow Memory
  17. 🤖 Supported Agents
  18. 📖 CLI Reference
  19. Documentation
  20. 🛠️ Development
  21. Star History
  22. 🤝 Contributing
  23. Contributors
  24. 📄 License
CompozyOS

CompozyOS

The system around the agent, already built.

An operating system for AI agents.

CI Release Go Report Card Go Reference License: MIT

Anyone can prompt an agent. Making agents work continuously is still an engineering project: loops, triggers, cron, permissions, approvals, observability, and the glue scripts that hold them together. CompozyOS turns that entire agent stack into one product, a complete environment to create, automate, and supervise agent work with the agent CLIs you already use (Claude Code, Codex, and Cursor). Built first for developers and technical operators.

[!NOTE] v0.4.0 is the first stable CompozyOS release. The previous v0.2 product has reached end of life and receives no further releases. Start with the migration guide before replacing an existing v0.2 installation.

CompozyOS web shell

✨ Highlights

  • Create. Sessions, agents, Loops, and capabilities are objects you author once and reuse, not scripts you rewrite per run.
  • Automate. Cron schedules, webhooks, and triggers keep work running with no terminal open.
  • Supervise. Approvals, permissions, run state, artifacts, and agent activity stay inspectable while work continues in the background.
  • Work survives the terminal. Sessions and Loop runs belong to the daemon, so closing one client does not erase the work.
  • Runs the agents you already use. ACP-compatible CLIs (Claude Code, Codex, and Cursor) operate the same daemon-owned state.
  • Batteries included. One runtime, one state model: loops and approvals are core objects, not plugins, reachable from web, CLI, HTTP/SSE, UDS, MCP, and native tools.
  • Local-first by default. One Go binary and SQLite-backed stores keep runtime state on the operator's machine unless a configured provider or extension owns an external boundary.
  • Remote access stays explicit. The Gateway pairs devices and exposes only the private or public surfaces an operator enables.
  • Built to extend. Agents, skills, capabilities, hooks, and extension kits plug into explicit runtime contracts.

📦 Installation

Verified installer

The installer pins the latest published release and verifies Sigstore provenance before installing the binary on macOS or Linux.

curl -fsSL https://compozy.com/install.sh | sh

Homebrew

brew install compozy/compozy/compozy

NPM

npm install -g @compozy/cli

Go

Install with the explicit tag shown on the latest release:

go install github.com/compozy/compozy@<release-tag>

From Source

git clone https://github.com/compozy/compozy.git
cd compozy
go build -o ./bin/compozy .

The installation guide covers installer flags, Linux packages, source builds, verification, and managed updates.

🔄 How It Works

CompozyOS control surfaces, daemon, runtime resources, state, and extension boundaries

People and agents send commands through public control surfaces. The home-scoped daemon resolves the workspace, applies permissions and runtime policy, coordinates ACP agents, and persists events and resource state. Web and streaming clients read that same daemon-owned truth instead of maintaining a parallel model.

Daemon Runtime Model

compozy daemon start, compozy status, and compozy daemon stop manage the local daemon. Sessions, tasks, Loop runs, automation and tools keep explicit owners and workspace boundaries. Use structured CLI output (-o json), HTTP/SSE, UDS, MCP, or native tools when another agent or program needs to manage the same resources.

Task Schema v2

Authored task files remain portable Markdown with typed frontmatter. The v0.3 runtime imports them into durable tasks and executes them through Loops; it does not revive the v0.2 tasks run pipeline. See Migrate from v0.2.15 for the exact schema and command changes.

⚙️ Config Files

Global defaults live in ~/.compozy/config.toml; a workspace can override supported fields through .compozy/config.toml. Explicit command flags win over workspace configuration, which wins over global configuration and built-in defaults.

compozy config path
compozy config validate
compozy config show -o json

Configuration, credentials, and provider-home policies have different owners. Follow the configuration guide instead of copying v0.2 state into a v0.3 home.

Reusable Agents

Agent definitions live under ~/.compozy/agents/<name>/ or .compozy/agents/<name>/. Each definition has an AGENT.md and may include an agent-local mcp.json. Workspace definitions override global definitions as a whole.

compozy agent list -o json
compozy agent info general -o json
compozy session new --agent general

🔌 Extensions

Extensions add versioned resources and runtime behavior through declared provide surfaces. The daemon owns discovery, enablement, trust decisions, lifecycle, and hooks; extensions do not bypass public runtime contracts.

Build one in three commands

compozy extension init hello --template tool-provider-go
compozy extension dev hello
compozy tool invoke ext__hello__search --workspace . --input '{"query":"compozy"}'

Executable extensions are code-first: declare the tool once in code and compozy extension build generates the manifest. Resource-only extensions can instead hand-write extension.toml and use the same build, dev, reload, and watch loop without running extension code. Walkthrough: Build your first extension.

SDK support

@compozy/extension-sdk (npm, MIT) and github.com/compozy/compozy/sdk/go are published and version-matched to the daemon.

Extension CLI

compozy extension list -o json
compozy extension status <name> -o json
compozy extension provenance <name> -o json
compozy extension logs <name> --follow

Learn more

Build an app

Use @compozy/client for TypeScript or github.com/compozy/compozy/sdk/go/client for Go to connect an external app to your running daemon. Both clients provide typed operations and agent streams; app tokens authorize trusted browser origins on the local listener.

Follow the Build an app tutorials for Node, a server-backed chat UI, browser access, Go, and token administration. The API reference includes generated SDK calls for each operation. These app SDK surfaces are experimental in 0.4; pin the exact version matching your daemon.

🚀 Quick Start

Bootstrap the home, start the daemon, enter the repository you want agents to work in, and create one durable session. CompozyOS infers and registers the workspace from the current directory; use --workspace <id|name|path> only when you need an override.

compozy install
compozy daemon start
compozy session new --agent general --name first-run

The Quick Start continues through the first prompt, live attachment, inspection, and cleanup.

🧩 Skills

Skills are daemon-discovered resources with explicit source and scope. Use the structured skill and marketplace surfaces to inspect what is active instead of copying v0.2 setup directories forward.

compozy skill list -o json
compozy skill inspect <name> -o json
compozy marketplace search --kind skill --query <term> -o json

🧠 Workflow Memory

Workflow memory is ordinary repository files under .compozy/tasks/<name>/memory/, written and read by the spec-cycle skills. The v0.2 workflow-memory files remain repository artifacts; they are not imported as hidden runtime state.

🤖 Supported Agents

CompozyOS runs ACP-compatible agent CLIs and adapters. The active provider catalog and each agent's runtime settings are runtime truth; inspect them before selecting a model or reasoning mode. See the provider guide for authentication and provider-home policies.

📖 CLI Reference

The generated CLI reference is authoritative for verbs, flags, structured output, and exit behavior. Start with:

compozy --help
compozy version
compozy doctor -o json

Documentation

🛠️ Development

CompozyOS is a Go and Bun monorepo. Start the daemon with automatic Go rebuilds and the web UI with Vite HMR:

make dev

To populate the Northstar Pay demo and leave its daemon running in the background:

make demo-seed
# Optional isolated home and secondary port:
make demo-seed DEMO_HOME="$HOME/.compozy-demo-other" DEMO_PORT=2125

This builds the daemon and Web bundle, replaces the seed-owned scenario, and starts the demo at http://localhost:2124 using ~/.compozy-demo by default. The main instance is unchanged. To reseed a running demo, first stop its daemon with COMPOZY_HOME="$HOME/.compozy-demo" ./bin/compozy daemon stop (use your custom home if overridden). The raw go run ./scripts/demo-seed --home <path> command remains available for data-only seeding. Existing demos in ~/.agh can still be selected explicitly with DEMO_HOME.

To prepare the same demo and open it in the Electron desktop shell:

make demo-seed-desktop
# The same overrides apply:
make demo-seed-desktop DEMO_HOME="$HOME/.compozy-demo-other" DEMO_PORT=2125

The desktop shell uses the demo home for its runtime connection and Electron profile. Quitting Electron leaves the demo daemon running in the background. As with demo-seed, stop an already-running demo before reseeding it.

Run the affected local gate before committing or pushing:

make gate

Delivery finishes in the draft PR: wait for every required CI check to pass on its current head.

Read AGENTS.md and the surface-specific instructions before editing.

Star History

Star History Chart

🤝 Contributing

Contributions are welcome. Open an issue or pull request, keep public behavior agent-manageable, and run make gate before sending changes, then keep the PR until its current-head CI is green. Security reports belong in the repository's private security channel, not a public issue.

Contributors

Thanks to everyone who has contributed to CompozyOS.

Contributors

📄 License

CompozyOS is distributed under the MIT License.

版本与发布记录

@compozy/cli 共发布 94 个版本,首次发布于 2025/08/07;过去 12 个月发布了 82 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.5.5latest2026/11/091 天前
0.5.42026/11/082 天前
0.5.32026/11/064 天前
0.5.22026/11/055 天前
0.5.12026/11/046 天前
0.5.02026/11/037 天前

其他发布通道:beta → 0.4.0。

关于 @compozy/cli 的常见问题

@compozy/cli 是什么?

One complete environment to create, automate, and supervise agent work.

如何安装 @compozy/cli?

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

@compozy/cli 支持 TypeScript 吗?

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

@compozy/cli 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@compozy/cli 可以商用吗?

@compozy/cli 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

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

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

@compozy/cli 还在维护吗?

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