# @context-forge/cli 中文文档

规范地址：https://npmcn.com/package/%40context-forge/cli/

版本：0\.19\.26
npm 元数据更新时间：2026-11-07T13:05:46.898Z
中文译文更新时间：2026-11-10T18:19:09.720Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40context-forge/cli
原文对照：https://npmcn.com/package/%40context-forge/cli/?lang=original
项目主页：https://github.com/ecorkran/context-forge/tree/main/packages/cli#readme
源码仓库：https://github.com/ecorkran/context-forge

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

- 包体积（解压后）：813 kB，325 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.18\.1
- 运行依赖：3 个
- 首次发布：2026-03-06T00:48:57.151Z
- 最新版本发布：2026-11-07T13:05:46.722Z
- 近 30 天下载量：3997（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：109（近 12 个月 109 个）

## 中文简介

CLI for Context Forge——终端访问上下文组装、项目管理、工作流程导航和配置

## 安装

```sh
npm install @context-forge/cli
```

也可以使用：`pnpm add @context-forge/cli`、`yarn add @context-forge/cli`、`bun add @context-forge/cli`

## README

# 翻译:

Context Forge的终端接口——上下文组装,项目管理,工作流程导航,和配置.

## 如何运作

`cf` 喜欢 `git` ——在全球安装,它根据您当前的工作目录自动检测您的工程. 没有配置文件可以管理每个项目; just `cd` 输入任何已注册的工程并运行命令.

## 安装

```bash
# Install globally (recommended: meta-package installs both CLI and MCP server)
npm install -g @context-forge/context-forge

# Or install the CLI alone
npm install -g @context-forge/cli

# Initialize a project (from the project root)
cd ~/repos/my-project
cf init

# Install the ai-project-guide templates (recommended)
cf guides install

# Install Claude Code slash commands (recommended)
cf install-commands
```

`cf init` 将当前目录注册为上下文 Forge 工程. `cf guides install` 鞋带 [项目指南](https://github.com/ecorkran/ai-project-guide) 提示模板,Context Forge的上下文引擎是围绕设计的. `cf install-commands` 添加 `/cf:*` 砍去克洛德代码的命令.

## 快速启动

```bash
# All commands are discoverable
cf --help
cf project --help

# Check project status
cf status

# Set project fields
cf set phase 6
cf set slice 175

# Browse project artifacts
cf list initiatives    # Architecture initiatives
cf list slices         # Slices in the active plan
cf list tasks          # Task files with progress
cf list items          # Individual tasks from the active task file

# What should I do next?
cf next

# Detailed information
cf project get

# View available prompt templates
cf prompt list

# Get a specific prompt with project variables substituted
cf prompt get P5
```

## Claude 代码斜线命令

当安装通过 `cf install-commands`,这些斜线命令直接在 Claude 代码会话中提供:

| 命令 | 说明 |
| --- | --- |
| `/cf:build` | 构建上下文提示( 接受) `--phase`, (中文(简体) ), `--slice` 旗帜) |
| `/cf:status` | 显示工程工作流程状态 |
| `/cf:get` | 显示全部工程字段 |
| `/cf:set` | 设置项目字段( 例如 ), `/cf:set phase 6`(中文(简体) ) |
| `/cf:prompt` | 获取或列出快速模板(例如, `/cf:prompt P5` 或者说 `/cf:prompt list`(中文(简体) ) |
| `/cf:project` | 管理项目(例如:, `/cf:project list`, (中文(简体) ), `/cf:project --schema`(中文(简体) ) |
| `/cf:next` | 显示下一个建议的行动 |
| `/cf:check` | 对项目文物进行一致性检查 |
| `/cf:onboard` | AI引导项目设置,然后交给 `cf build`。在一条线命名后,它就会停止 `sq onboard` 选择退出 |

每个命令运行 `cf` 在盖子下——基于CWD的相同项目分辨率,输出相同.

## 图标参考

### 列出命令

| 命令 | 说明 |
| --- | --- |
| `cf list projects` | 列出所有已注册的项目 |
| `cf list initiatives` | 带有分数的建筑举措 |
| `cf list arch` | 别名 `cf list initiatives` |
| `cf list plans` | 完成进度的剪切计划文件 |
| `cf list slices` | 从现行计划中提取的片段 状态。 一个被采纳的密码库记录的历史条目 `✓ retroactive`; 见 [标记豁免的](https://npmcn.com/package/docs/REVIEW-GATING.md#retroactive-slices) |
| `cf list tasks` | 计划中有进度的任务文件 |
| `cf list items` | 活动任务文件中的单个任务 |

### 项目和工作流程

| 命令 | 使用量 | 说明 |
| --- | --- | --- |
| `cf init` | `cf init [--json]` | 将当前目录注册为项目 . `cf init --json` 打印步骤结果; 失败的步出 1, 是否 `--json`。它会打印一行命名 `sq onboard` 和选择退出。 见 [收养](https://npmcn.com/package/docs/ADOPTION-PRIMITIVES.md) |
| `cf detect` | `cf detect [--path <dir>] [--json]` | 仅读目录内容及是否需要通过的报告. 工作在未注册目录上. 见 [收养](https://npmcn.com/package/docs/ADOPTION-PRIMITIVES.md) |
| `cf status` | `cf status [--json]` | 显示工作流程状态 |
| `cf next` | `cf next [--json]` | 显示推荐的下一个动作 。 对于未被采纳或未完全采纳的重播,它打印出一行命名 `sq onboard` 和选择退出;否则它通常导航 |
| `cf build` | `cf build [--phase] [--slice] [--json]` | 生成上下文提示 |
| `cf set` | `cf set <field> <value>` | 设置项目字段( 例如) `cf set comprehension <path>` 登记密码库理解文件; `""` 已经清除) |
| `cf get` | `cf get [--json]` | 显示全部工程字段 |
| `cf check` | `cf check [--fix] [--slice <n>] [--json]` | 运行一致性检查 |
| `cf future` | `cf future [--status <filter>] [--json]` | 今后合并的工作 |
| `cf project` | `cf project list|get|set|rm` | 管理项目 |
| `cf prompt` | `cf prompt list|get <phase> [--path <dir>] [--comprehension <file>]` | 访问快速模板 . `--path` 使用该目录所登记的项目; `--comprehension` 命名一个代码库解析文件,以用于引用其配置文件输入的提示。 见 [收养](https://npmcn.com/package/docs/ADOPTION-PRIMITIVES.md) |
| `cf rules inventory` | `cf rules inventory --json` | 列出指南的规则文件,项目自己的规则来源和所存储的分辨率为JSON. 只读 |
| `cf rules resolve` | `cf rules resolve <guideRule> <projectSource> --statement "<text>"` | 记录关于指南规则和项目规则源之间冲突的决定。 运行 `cf setup-ide <target>` 然后应用它 |
| `cf docs map` | `cf docs map` | 写入或刷新 `project-documents/user/architecture/050-docs-map.{project}.md`,一个连接项目现有README的索引, `docs/` 和发展成果评估 |
| `cf version` | `cf version [--json]` | 显示版本( JSON 包括断开更改) |
| `cf help` | `cf help [--json]` | 显示帮助( JSON 输出命令目录) |

### 行政部门

| 命令 | 说明 |
| --- | --- |
| `cf worktree init|list|get|update|rm` | 管理 git 工作树背景 |
| `cf config get|set` | 管理配置 |
| `cf guides install|status|update|uninstall` | 管理ai- 项目指南模板 |
| `cf backup` | 创建项目数据的版本备份 |
| `cf install-commands` | 安装 Claude 代码斜线命令 |
| `cf setup-ide claude` | 配置 IDE 集成 |

## 规则 决议

已通过的项目遵守自己的规则(`CLAUDE.md`, (中文(简体) ), `AGENTS.md`, (中文(简体) ), `.cursor/rules`在向导旁边. `cf rules inventory` 列表两边;用于复合文件,例如 `CLAUDE.md` 它给出了被管理的块的行范围,所以只比较它以外的项目拥有的文本. 比较是代理人的工作(指南提示) `conventions-reconciliation`从不考虑两项规则是否冲突。 每项决定记录在 `cf rules resolve`。清单中的每一项指南规则都有 `agents` 字段:来自 `agents:` 标记 (`claude`, (中文(简体) ), `agents`, (中文(简体) ), `copilot`, (中文(简体) ), `cursor`),或 `null` 当它去每一个代理。 一项决议只使管理下的区块符合其规则.

决议存储于 `.context-forge/rule-resolutions.json`承诺:

```json
{
  "version": 1,
  "resolutions": [
    { "guideRule": "git.md", "projectSource": "CLAUDE.md",
      "statement": "Every change goes through a PR; never commit directly to main." }
  ]
}
```

-   解析度由文件对对确定(`guideRule` 是指南中的规则文件名, `projectSource` 因此,对指南规则的重新措辞会使其生效.
-   `statement` 是一行,已储存并逐字渲染。 它可能不包含换行符,名字中的回转符,或任何上下文forge标记注释. 错误的文件失败 `setup-ide` 在写东西之前.
-   每个 `setup-ide` 运行使实时分辨率成为 `## Project Rule Resolutions` 每一管理区块末尾的区块`CLAUDE.md`, (中文(简体) ), `AGENTS.md`, (中文(简体) ), `.github/copilot-instructions.md`) (中文(简体) ). 重跑给出相同的文件 。 没有分辨率文件,输出不变.
-   A. 关于范围化指南规则的决议 `rules.exclude` 已跳过,无需注释.
-   如果一个解析器命名了指南规则,该指南不再有,或者项目文件已经不存在, `setup-ide` 在stderr(出站码为0)上发出警告,而不发布.
-   要删除一个分辨率,请用手编辑 JSON 文件 .
-   优先是咨询。 相冲突的向导文本留在块和已安装范围规则文件中;该部分告诉代理商哪个规则获胜.

## 常见选项

-   `--project <name|id>` ——通过名称或ID来覆盖活动项目
-   `--json` 产出为JSON(不适用于 `build` 财务报告和审定财务报表 `prompt get`(中文(简体) )

## 项目分辨率

`cf` 确定使用优先环节运行的项目:

1.  **`--project` 旗帜** - 最高优先级。 接受工程名称或ID.
2.  **CWD 检测** ——如果当前目录位于已注册项目路径内,或已注册工作树路径内,则该项目(和工作树)将自动解决.
3.  **Git 工作树检测** 如果CWD是已知项目未注册的git worktree,则项目会自动解决(运行前有用) `cf worktree init`) (中文(简体) ).
4.  **`default_project` 配置** - 如果设置通过 `cf config set default_project <name>`,用作倒计时.

这意味着您只需管理多个工程 `cd`\- 在他们之间 - 不需要切换命令.

## 阶段短手

`cf prompt get` 财务报告和审定财务报表 `cf build --phase` 接受相位缩写 :

| 简写 | 阶段 |
| --- | --- |
| 临1 | 概念 |
| 临2 | 建筑 |
| 临3 | 切片规划 |
| 页:1 | 剪切设计 |
| 五常 | 任务分类 |
| 临6 | 执行情况 |
| 临7 | 一体化 |

短手取出于项目的即时资产文件.

## 阶段/ 指令自动设置

设置开发阶段自动更新 `instruction` 匹配 :

```bash
cf set phase 6
# Updated phase = Phase 6: Implementation on project my-project
# Updated instruction = Phase 6: Implementation (auto-set from phase)
```

设置 `instruction` 直接不变 `developmentPhase`。 。 。 .

## 智能索引分辨率

按数值索引设置文物字段解析到磁盘上的匹配文件 :

```bash
cf set slice 175
# Updated slice = 175-slice.context-output-consolidation on project my-project
# Updated tasks = 175-tasks.context-output-consolidation (auto-set from slice)
```

当还没有文件存在时, CLI 来源于切片计划条目 :

```bash
cf set slice 166
# (no 166-slice.*.md on disk — derives from plan entry "Consistency Checker")
# Updated slice = 166-slice.consistency-checker on project my-project
# Updated tasks = 166-tasks.consistency-checker (auto-set from slice)
```

设置 `fileSlice` 总是自动设置 `fileTasks` 来匹配.

## 建筑

CLI 包装 `@context-forge/core` 直接(无 MCP 层). 所有核心服务均从下列来源进口: `@context-forge/core/node`。 。 。 .

## 发展(莫诺雷波)

```bash
pnpm --filter @context-forge/cli build     # Compile TypeScript
pnpm --filter @context-forge/cli dev       # Watch mode
pnpm --filter @context-forge/cli test      # Run tests
pnpm --filter @context-forge/cli typecheck # Type check
```

## 更改日志

### v. 6.0 (单位:千美元)

-   **复合工作流程命令** —— 说 `cf concept`, (中文(简体) ), `cf initiatives`, (中文(简体) ), `cf arch <n>`, (中文(简体) ), `cf plan <n>`, (中文(简体) ), `cf slice <n>`, (中文(简体) ), `cf tasks <n>`, (中文(简体) ), `cf implement <n>` 设定文物 + 相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相
-   **`cf list` 合并** ——所有文物上市 `cf list <type>` (单位:千美元)`cf list slices`, (中文(简体) ), `cf list tasks`页:1
-   **斜线命令** - 16 Claude Code slash命令,用于大院命令、状态和工作流程
-   **`cf help --json`** 用于代理消费的机器可读指令目录
-   **`cf version --json`** ——版本回溯并中断更改跟踪
-   **结构化 JSON 错误** ——所有错误代码 `UserError` 实例, JSON 出错输出通过 `--json` 或者说 `CF_JSON=1`
-   **《同上》** —— 说 `cf set` 检测不更改和跳过写入
-   **`cf guides uninstall`** ——清除引导子模块或克隆

### 页:1

-   **工作树木支助** —— 说 `cf worktree init|list|get|update|rm` 平行的多举措发展; `cf status --worktree` 财务报告和审定财务报表 `--worktrees` 交叉目录访问
-   **了解工作树木项目解决方案** ——自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来自来 `cf worktree init`
-   **工作树范围田径** —— 说 `cf set phase/slice/tasks/arch/plan` 更新活动 `WorktreeContext` 当他从一棵树上得逞的时候
-   **`cf check` 在所有工作树上** ——一致性检查 正确查看工作树范围字段(相位,切片,拱等)
-   **`cf check --slice <n>`** - 检查范围为特定部分; `--yes` 在固定模式中跳过确认
-   **`cf tasks` 命令** - 改名自 `cf task` 一致性(`cf tasks list`, (中文(简体) ), `cf tasks items`(中文(简体) )
-   **`cf backup`** ——版本化项目数据备份,自动刷新(保存上10个)
-   **`cf setup-ide claude`** 配置 Claude 代码集成与 CLAUDE.md 备份安全

### 页:1

-   **发现命令** —— 说 `cf arch list`, (中文(简体) ), `cf plan list`, (中文(简体) ), `cf slice list`, (中文(简体) ), `cf tasks list`, (中文(简体) ), `cf tasks items` 用于各级浏览项目文物
-   **智能索引分辨率** —— 说 `cf set slice 166` 当磁盘上不存在文件时, 从切片计划中生成文件名
-   **自动设定文件任务** 设置 `fileSlice` 总是自动设置 `fileTasks`,即使任务文件尚未存在
-   **增强 `cf status`** 现在显示日期、 Arch 和 Plan 字段
-   **工作流程导航** —— 说 `cf status` 财务报告和审定财务报表 `cf next` 由 `WorkflowNavigator` 附带零碎状态推导和优先排序的下一步行动建议

### v0.3.0 (韩语)

-   **模板变量补全** ——文物田地(`fileArch`, (中文(简体) ), `fileSlicePlan`, (中文(简体) ), `fileHLD`, (中文(简体) ), `fileSpec`)和别名(`arch`, (中文(简体) ), `plan`, (中文(简体) ), `hld`, (中文(简体) ), `spec`以快速模板提供,并提取索引(`archIndex`, (中文(简体) ), `planIndex`(中文(简体) )
-   **合并项目背景** —— 说 `cf build` 输出使用干净的密钥值 `### Project Context` 块取而不用括号包装格式; `template` 字段已删除; 整个使用的计划字段名称
-   **统一开幕词** – 总是"在{名称}上工作"... 无论工作类型 Type
-   **阶段自动设定指令** —— 说 `cf set phase N` 也更新 `instruction` 以匹配
-   **顶级快捷键** —— 说 `cf set` 财务报告和审定财务报表 `cf get` 作为快捷键工作 `cf project set/get`
-   **代码参考** —— 当活动提示的配置列表 `fileComprehension` 或者说 `fileDocsMap`, (中文(简体) ), `cf build` 添加a `### Codebase Reference` 在“工程上下文”之后的段落中,指定已注册的理解文档和文档地图,文档地图显示为 `current` 或者说 `out of date` (见 `docs/ADOPTION-PRIMITIVES.md`(中文(简体) )

### 页:1

-   **基于CWD的项目检测** —— 说 `cf` 从当前目录自动检测工程
-   **基于名称的决议** ——使用 `--project orchestration` 带有项目名称而不是ID
-   **决议指标** —— 说 `cf status` 显示项目是如何解决的(`from CWD`, (中文(简体) ), `--project flag`(中文(简体) )
-   **压缩 `cf project list`** - 名称/平面/剪切列 `*` 活动指标和 `~` 路径缩短
-   **更紧的输出格式** ——标签一致,被压制为空字段,标准化出错信息

### 页:1

-   初始发布带有8个命令 : `status`, (中文(简体) ), `next`, (中文(简体) ), `build`, (中文(简体) ), `config`, (中文(简体) ), `project`, (中文(简体) ), `future`, (中文(简体) ), `check`, (中文(简体) ), `prompt`
-   与 `@context-forge/core` 用于上下文组装
-   快速模板的相近手势
-   所有适用命令的 JSON 输出模式

## 常见问题

### @context-forge/cli 是什么？

CLI for Context Forge——终端访问上下文组装、项目管理、工作流程导航和配置

### 如何安装 @context-forge/cli？

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

### @context-forge/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @context-forge/cli 支持 ESM 还是 CommonJS？

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

### @context-forge/cli 需要什么版本的 Node\.js？

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

### @context-forge/cli 可以商用吗？

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

### @context-forge/cli 的下载量有多少？

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

### @context-forge/cli 还在维护吗？

最新版本 0\.19\.26 发布于 2026/11/07（3 天前）；至今共发布 109 个版本，其中过去 12 个月发布了 109 个；首次发布于 2026/03/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。