# @compozy/cli 中文文档

规范地址：https://npmcn.com/package/%40compozy/cli/

版本：0\.5\.5
npm 元数据更新时间：2026-11-09T14:17:44.918Z
中文译文更新时间：2026-11-10T14:16:14.032Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40compozy/cli
原文对照：https://npmcn.com/package/%40compozy/cli/?lang=original
项目主页：https://compozy.com/
源码仓库：https://github.com/compozy/compozy

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：23.1 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2025-08-07T14:18:45.859Z
- 最新版本发布：2026-11-09T14:17:44.450Z
- 近 30 天下载量：5020（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：94（近 12 个月 82 个）

## 中文简介

一个完整的环境来创造、自动化和监督代理工作.

## 安装

```sh
npm install @compozy/cli
```

也可以使用：`pnpm add @compozy/cli`、`yarn add @compozy/cli`、`bun add @compozy/cli`

## README

![CompozyOS](https://npmcn.com/package/%40compozy/cli/packages/site/public/icon-512.png)

# 混音系统

**特工周围的系统 已经建成了.**

AI代理的操作系统.

 [![CI](https://github.com/compozy/compozy/actions/workflows/ci.yml/badge.svg)](https://github.com/compozy/compozy/actions/workflows/ci.yml)[![Release](https://img.shields.io/github/v/release/compozy/compozy?include_prereleases) ](https://github.com/compozy/compozy/releases)[![Go Report Card](https://goreportcard.com/badge/github.com/compozy/compozy) ](https://goreportcard.com/report/github.com/compozy/compozy)[![Go Reference](https://pkg.go.dev/badge/github.com/compozy/compozy.svg) ](https://pkg.go.dev/github.com/compozy/compozy)[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://npmcn.com/package/%40compozy/cli/LICENSE)

任何人都可以请人帮忙 让代理持续工作仍然是一个工程项目:循环, 触发器、克龙、权限、批准、可观察性以及持有它们的胶质脚本 一起来 CompozyOS将整个代理堆栈变成一个产品,一个完整的环境到 创建、自动化和监督代理与您已经使用的代理CLI工作(Claude Code, Codex, and Cursor. (原始内容存档于2018-09-29). 先为开发者和技术操作者所建.

> \[注\] v. 4.0是首个稳定的CompoziOS发布. 之前的 v0.2 产品已到寿命结束 不得再被释放。 开始于 [移徙指南](https://npmcn.com/package/%40compozy/cli/MIGRATION_GUIDE.md) 在此之前 替换现有的 v. 2. 安装.

![CompozyOS web shell](https://npmcn.com/package/%40compozy/cli/imgs/screenshot.png)

## 重点

-   **创建.** 会话、代理、循环和能力是您编写并重复使用的对象,而不是 每次重写脚本.
-   **自动化.** Cron时刻表,webhoks,和触发器保持工作运行,没有终端打开.
-   **监督.** 批准、许可、运行状态、文物和代理活动可进行检查 而在背景中继续工作.
-   **工程在终点站生存.** 会话和循环运行属于守护进程, 因此关闭一个客户端 不删除工作.
-   **运行您已经使用的代理 .** 非加太兼容的CLI(Claude Code、Codex和Cursor) 运行同一个守护进程拥有的国家.
-   **包括电池.** 一次运行,一次状态模式:循环和批准是核心 对象,而非插件,可以从web,CLI,HTTP/SSE,UDS,MCP,和本地工具中达到.
-   **默认为本地第一.** 一个去二进制和SQLite后置的商店保持运行时态 操作员的机器,除非配置的提供者或扩展拥有外部边界.
-   **远程访问明确无误.** 这个 [网关](https://compozy.com/docs/gateway) 双相设备,并只暴露操作员所允许的私人或公共表面.
-   **建为通延.** 特工、技能、能力、钩子和扩展包插入 明确的运行时间合同.

## \* 安装

#### 已验证的安装器

安装者在安装前将最近发布的版本标出并验证Sigstore出处 macOS或Linux上的二进制.

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

#### 土生土长

```bash
brew install compozy/compozy/compozy
```

#### 国家预防机制

```bash
npm install -g @compozy/cli
```

#### 走开

安装, 使用显示在 [最新发布](https://github.com/compozy/compozy/releases/latest)数字 :

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

#### 从源

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

这个 [安装指南](https://compozy.com/docs/getting-started/installation) 覆盖 安装者旗, Linux 软件包, 源代码构建, 校验, 以及管理的更新 .

## \* 如何运作

![CompozyOS control surfaces, daemon, runtime resources, state, and extension boundaries](https://npmcn.com/package/%40compozy/cli/imgs/how-it-works-flow.png)

人民和特工通过公共控制表面发出命令. 主瞄准守护进程解析 工作空间,应用权限和运行时间政策,协调非加太代理机构,以及持续发生的事件 资源状态。 网络和流媒体客户端读取同一守护进程拥有的真理,而不是维持一个 并行模式.

### 守护进程运行时模式

`compozy daemon start`, (中文(简体) ), `compozy status`,以及 `compozy daemon stop` 管理本地守护进程 . 会话、任务、循环运行, 自动化和工具保持明确的所有者和工作空间界限。 使用 结构化的 CLI 输出 (`-o json`), HTTP/SSE, UDS, MCP, 或当另一个代理或程序时的本地工具 需要管理同样的资源.

### 任务Schema v2

授权任务文件仍为可移植 Markdown 有打出前题 。 v0.3 运行时间导入它们 进入持久任务,并通过循环执行; 它不会使 v0. 2 恢复 `tasks run` 输油管. 见 [从v. 2.15 迁移](https://npmcn.com/package/%40compozy/cli/MIGRATION_GUIDE.md) 精确的策略和命令更改.

## QQ 配置文件

全球默认存在 `~/.compozy/config.toml`; 工作空间可以通过 `.compozy/config.toml`。明确命令旗胜过工作空间配置,工作空间配置胜出 全局配置和内置默认值.

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

配置、证书和供应商家庭政策有不同的所有人。 跟着 [配置指南](https://compozy.com/docs/configuration/config-toml) 而不是复制 v0.2状态为 v0.3 家.

## 可重复使用的代理工具

代理定义在下面 `~/.compozy/agents/<name>/` 或者说 `.compozy/agents/<name>/`。每个定义 有一个 `AGENT.md` 并且可能包括当地代理人 `mcp.json`. 工作空间定义凌驾全球 定义作为一个整体.

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

## ++ 扩展

扩展通过声明添加版本资源并运行时间行为提供表面. 守护进程 拥有发现、授权、信任决定、生命周期和钩子;扩展不会绕过公共 运行时间合同.

### 3个命令中建一个

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

可执行扩展名是代码先: 一次在代码中声明工具并 `compozy extension build` 生成列表。 仅限资源的扩展可以代替手写 `extension.toml` 并使用 相同的构建, dev, 重新加载, 和监视循环而不运行扩展代码. 走过 : [构建您的第一个扩展名](https://compozy.com/docs/guides/build-your-first-extension)。 。 。 .

### SDK 支持

`@compozy/extension-sdk` (npm,麻省理工学院)和 `github.com/compozy/compozy/sdk/go` 发表和 版本匹配到守护进程 .

### 扩展 CLI

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

### 学多点

-   [构建您的第一个扩展名](https://compozy.com/docs/guides/build-your-first-extension)
-   [扩展](https://compozy.com/docs/extensions)
-   [发布扩展名](https://compozy.com/docs/extensions/publish)
-   [能力和推广包](https://compozy.com/docs/extensions)
-   [官方 CompozyOS 技能](https://npmcn.com/package/%40compozy/cli/skills/compozy/)
-   [移徙指南](https://npmcn.com/package/%40compozy/cli/MIGRATION_GUIDE.md)

## 构建应用程序

使用 `@compozy/client` 用于类型脚本或 `github.com/compozy/compozy/sdk/go/client` 用于连接 您运行守护进程的一个外部应用程序 。 两个客户都提供打字业务和代理流; 应用程序令牌授权本地收听器上的可信任浏览器来源 .

跟着 [构建应用程序教程](https://compozy.com/docs/apps) 对于节点,一个服务器支持的聊天UI, 浏览器访问,去,和令牌管理. 这个 [API 参考](https://compozy.com/docs/api) 包括每次操作生成的SDK呼叫. 这些应用SDK表面在0.4中为实验; 标出匹配您守护进程的确切版本 .

## QQ 快速启动

启动守护进程, 进入您想要代理的仓库, 并创建一个 持续的会议。 CompozyOS 从当前目录中推断并注册工作空间; 使用 `--workspace <id|name|path>` 只有在你需要控制时.

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

这个 [快速启动](https://compozy.com/docs/getting-started/quick-start) 继续通过 首先迅速,现场的附着,检查,和清理.

## 技能

技能是守护进程发现的资源,有明确的来源和范围. 使用结构化的技能和 市场表面,用于检查活动内容,而不是向前复制 v0.2 设置目录.

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

### 工作流程内存

工作流内存是普通寄存器文件 `.compozy/tasks/<name>/memory/`,写作和阅读 光谱循环技能。 v.0.2工作流程-记忆文件仍然是仓库文物;它们不是 导入为隐藏运行时状态.

### \* 支助代理人

CompozyOS运行ACP兼容剂CLI和适配器. 活动提供者目录和每个代理目录 运行时设置是运行时的真伪;在选择模型或推理模式之前检查它们. 见 [提供者指南](https://compozy.com/docs/agents/providers) 用于认证和 提供家庭政策.

## CLI 参考

生成的 [CLI 参考](https://compozy.com/docs/cli-reference) 对动词是权威的, 旗帜、结构输出和退出行为。 以 :

```bash
compozy --help
compozy version
compozy doctor -o json
```

## 文档

-   [运行时间概览](https://compozy.com/docs)
-   [安装](https://compozy.com/docs/getting-started/installation)
-   [快速启动](https://compozy.com/docs/getting-started/quick-start)
-   [从v. 2.15 迁移](https://npmcn.com/package/%40compozy/cli/MIGRATION_GUIDE.md)
-   [CLI 参考](https://compozy.com/docs/cli-reference)
-   [GitHub 发布](https://github.com/compozy/compozy/releases)

## 发展

CompoziOS是Go和Bun monorepo的游戏. 以自动 Go 启动守护进程 虚拟高频:

```bash
make dev
```

要使用北星付费演示并让守护进程运行在背景中:

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

这构建了守护进程和 Web 捆绑, 替换种子拥有的情景, 并开始 演示在 `http://localhost:2124` 使用 `~/.compozy-demo` 默认。 主要内容 实例不变。 要重播正在运行的演示, 请先用 `COMPOZY_HOME="$HOME/.compozy-demo" ./bin/compozy daemon stop` (使用您的自定义的家) 如果被推翻的话。 生下来的 `go run ./scripts/demo-seed --home <path>` 命令保留 仅供数据种子使用。 现有演示 `~/.agh` 仍然可以选择 明确使用 `DEMO_HOME`。 。 。 .

为了准备同样的演示并在电子桌面外壳中打开:

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

桌面外壳使用演示主机进行运行时连接和 Electron 简介。 取出电动让演示守护进程在背景中运行. 一样 `demo-seed`在重播之前, 停止一个已经运行的演示.

在实施或推进前先运行受影响的当地大门:

```bash
make gate
```

交付在PR草案中完成:等待每一次所需的CI检查来传递其当前头部.

读取 [一般事务人员(其他职等)](https://npmcn.com/package/%40compozy/cli/AGENTS.md) 和编辑前的表面指示.

## 恒星历史

[![Star History Chart](https://api.star-history.com/chart?repos=compozy/compozy&type=date&legend=top-left)](https://www.star-history.com/?repos=compozy%2Fcompozy&type=date&legend=top-left)

## 捐款

欢迎捐款。 打开一个问题或拉请求, 保持公共行为代理管理 运行 `make gate` 在发送更改前, 然后保留 PR 直至其当前标题 CI 为绿色 . [安保报告](https://npmcn.com/package/%40compozy/cli/SECURITY.md) 属于仓库 私人安全频道 不是公共问题.

## 贡献者

感谢所有为CompozyOS做出贡献的人.

[![Contributors](https://contrib.rocks/image?repo=compozy/compozy)](https://github.com/compozy/compozy/graphs/contributors)

## 许可证

CompozyOS 以 [MIT 许可证](https://npmcn.com/package/%40compozy/cli/LICENSE)。 。 。 .

## 常见问题

### @compozy/cli 是什么？

一个完整的环境来创造、自动化和监督代理工作\.

### 如何安装 @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 和提交记录判断。

