# @context-forge/core 中文文档

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

版本：0\.19\.26
npm 元数据更新时间：2026-11-07T13:06:05.623Z
中文译文更新时间：2026-11-10T17:23:20.888Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.5 MB，579 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.18\.1
- 运行依赖：4 个
- 首次发布：2026-02-23T19:14:22.861Z
- 最新版本发布：2026-11-07T13:06:05.444Z
- 近 30 天下载量：4426（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：111（近 12 个月 111 个）

## 中文简介

Content Forge 的核心上下文生成引擎——模板处理,项目状态,即时组装

## 安装

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

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

## README

# @ context-forge/ 核心

赋予Context Forge权力的上下文生成引擎. 处理模板,项目状态管理,即时解析,区段建设,以及全上下文组装管线.

## 概览

此软件包包含该软件包共享的核心逻辑 [MCP 服务器](https://npmcn.com/package/%40context-forge/mcp-server/README.md),则 [国 际](https://npmcn.com/package/%40context-forge/cli/README.md)其他节点的消费者。 它没有框架依赖性.

关键能力:

-   **背景管道** - 从项目配置、模板和报表中汇集结构化上下文提示
-   **模板处理** ——可变替代`{{projectName}}`, (中文(简体) ), `{{fileSlice}}`, (中文(简体) ), `{fileArch}`, (中文(简体) ), `{archIndex}`) 带有有条件部分和文物别名
-   **报表管理** ——加载并解析默认语句(项目入门,工具入门,指令块)
-   **快速解析** - 读取 `prompt.ai-project.system.md` 文件并提取已命名的模板部分
-   **项目存储** ——备有备份和迁移支持的项目配置文件系统支持的CRUD

## 导出路径

该包提供了两个切入点,从Node.js依赖代码中分离出浏览器安全代码.

### `@context-forge/core` - 类型、界面和浏览器安全服务

```typescript
import type { ProjectData, UpdateProjectData } from '@context-forge/core';
import type { IProjectStore, IStorageService } from '@context-forge/core';
import { TemplateProcessor, SectionBuilder } from '@context-forge/core';
import { ContextGenerator, ContextIntegrator } from '@context-forge/core';
import { PROMPT_FILE_RELATIVE_PATH, DEFAULT_STATEMENTS } from '@context-forge/core';
```

此切入点包含否 `fs` 或者说 `path` 依赖性,对于浏览器/上下文是安全的.

### `@context-forge/core/node` ——节点js实施

```typescript
import { FileProjectStore, FileStorageService } from '@context-forge/core/node';
import { createContextPipeline } from '@context-forge/core/node';
import { StatementManager, SystemPromptParser } from '@context-forge/core/node';
import { ProjectPathService } from '@context-forge/core/node';
import { getStoragePath } from '@context-forge/core/node';

// Artifact introspection
import { ArtifactIntrospector } from '@context-forge/core/node';
import { buildModel, scanDirectory } from '@context-forge/core/node';
import { parseFrontmatter, parseSlicePlan } from '@context-forge/core/node';
import { parseTaskItems, parseTaskFile } from '@context-forge/core/node';
import { parseFutureWork, detectDocuments } from '@context-forge/core/node';
import { FutureWorkCollector } from '@context-forge/core/node';
```

此入口包括依赖文件系统的服务. 在主要流程,CLI工具,MCP服务器,以及测试中使用. 不从浏览器/ 转发器代码导入 .

## 关键服务

| 服务 | 入口 | 说明 |
| --- | --- | --- |
| `FileProjectStore` | `./node` | 文件系统支持的 CRUD 项目( 读取、 创建、 更新、 删除) |
| `createContextPipeline` | `./node` | 将所有服务连接到项目路径并返回随时使用的工厂 `ContextIntegrator` |
| `StatementManager` | `./node` | 装入和剖析 `default-statements.md` 从项目目录中 |
| `SystemPromptParser` | `./node` | 参数 `prompt.ai-project.system.md` 输入已命名的模板区域 |
| `ProjectPathService` | `./node` | 解析相对于项目根的文件路径( 任务文件、 切片设计、 指南) |
| `ContextIntegrator` | `.` | 管弦乐从一个 `ProjectData` 对象 |
| `TemplateProcessor` | `.` | 处理 `{{variable}}` 在模板字符串中替换,包括文物别名(`{arch}`, (中文(简体) ), `{plan}`, (中文(简体) ), `{hld}`, (中文(简体) ), `{spec}`)和指数提取(`{archIndex}`, (中文(简体) ), `{planIndex}`(中文(简体) ) |
| `SectionBuilder` | `.` | 组合单个上下文部分(报表、指示、工具) |
| `ArtifactIntrospector` | `./node` | 分析方法文件:切片计划、任务文件、前题、今后的工作、文件检测 |
| `buildModel` | `./node` | 构建完整 `ProjectModel` 基础、倡议、切片、任务、未来工作 |
| `FutureWorkCollector` | `./node` | 将未来工作项目汇总到所有切片计划中;按举措分组;支持状态过滤 |

## 摩诺雷波语的使用

```
packages/
  context-forge/ @context-forge/context-forge — meta-package (installs cli + mcp)
  core/          ← this package
  cli/           depends on @context-forge/core (workspace:*)
  mcp-server/    depends on @context-forge/core (workspace:*)
  electron/      depends on @context-forge/core (workspace:*)
```

MCP 服务器、 CLI 和 Electron app 导入类型 `@context-forge/core` 和节点服务 `@context-forge/core/node`。 。 。 .

## 许可证

麻省理工学院

## 常见问题

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

Content Forge 的核心上下文生成引擎——模板处理,项目状态,即时组装

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

在项目目录运行 npm install @context-forge/core，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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

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

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