@cleocode/cleo

中文文档
2026.11.1发布于 2026/11/12MITES Module构建来源已验证近 30 天下载 1.2万

CLEO CLI — the assembled product consuming @cleocode/core

原始使用文档
文档目录5 节
  1. Install
  2. Quick start
  3. Finding commands
  4. Programmatic use
  5. License

@cleocode/cleo

Part of CLEO. Start with the root README; run cleo <command> --help for any command.

The cleo command-line interface: tasks, evidence gates, pull-request closing, docs, memory (BRAIN), code intelligence (Nexus) and release, for AI coding agents and the people who work with them. Every call prints one JSON envelope on stdout; logs and progress go to stderr.

Install

npm install -g @cleocode/cleo

Requires Node.js >= 24.16.0. The package installs the cleo binary (and ct as an alias) and pulls in @cleocode/core, the SDK it is built on.

Quick start

cd your-project
cleo init
cleo session start --scope global --name "first session"
cleo saga create --title "Ship the auth hardening" --acceptance "login is rate limited|sessions expire"
cleo next

The full quick start, the pull-request flow and the docs workflow are in the root README.

Finding commands

The command set changes between releases, so this README does not list it. Ask the CLI:

cleo <command> --help          # flags and usage for one command
cleo <command> <sub> --help    # for a sub-command, e.g. cleo docs update --help

Command output is JSON by default. --field <json-pointer> extracts one value, --output id|count|table|silent changes the shape, and --human renders for people.

Programmatic use

Agents and tools can call the SDK directly instead of spawning the CLI; see @cleocode/core.

License

MIT

版本与发布记录

@cleocode/cleo 共发布 449 个版本,首次发布于 2026/02/22;过去 12 个月发布了 449 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2026.11.1latest2026/11/12今天
2026.11.1-rc.ci.711canary2026/11/12今天
2026.11.1-canary.122026/11/12今天
2026.11.1-canary.112026/11/12今天
2026.11.1-canary.102026/11/12今天
2026.11.1-canary.92026/11/111 天前

其他发布通道:beta → 2026.3.20-beta.1,canary → 2026.11.1-rc.ci.711。

关于 @cleocode/cleo 的常见问题

@cleocode/cleo 是什么?

CLEO CLI — the assembled product consuming @cleocode/core

如何安装 @cleocode/cleo?

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

@cleocode/cleo 支持 TypeScript 吗?

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

@cleocode/cleo 支持 ESM 还是 CommonJS?

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

@cleocode/cleo 需要什么版本的 Node.js?

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

@cleocode/cleo 可以商用吗?

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

@cleocode/cleo 的下载量有多少?

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

@cleocode/cleo 还在维护吗?

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