# @chemx/starter-kit 中文文档

规范地址：https://npmcn.com/package/%40chemx/starter-kit/

版本：26\.11\.15-614
npm 元数据更新时间：2026-11-15T10:38:41.033Z
中文译文更新时间：2026-11-14T21:32:20.847Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40chemx/starter-kit
原文对照：https://npmcn.com/package/%40chemx/starter-kit/?lang=original
项目主页：https://chemicalx.xophz.com/
源码仓库：https://github.com/Chemical-X-Protocol/starter-kit

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

- 包体积（解压后）：6 MB，1116 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.13\.0
- 运行依赖：6 个
- 首次发布：2026-09-09T06:07:07.141Z
- 最新版本发布：2026-11-15T10:38:40.845Z
- 近 30 天下载量：3250（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 57 个）

## 中文简介

化学 X 协议:私人落地式建筑启动装置和胶囊发生器

## 安装

```sh
npm install @chemx/starter-kit
```

也可以使用：`pnpm add @chemx/starter-kit`、`yarn add @chemx/starter-kit`、`bun add @chemx/starter-kit`

## README

# chemx: AI 编码代理与您的编码库之间的工具包

![Chemical X Starter Kit Comic Logo](https://npmcn.com/package/%40chemx/starter-kit/assets/chemx-starter-kit-logo.gif)

[![Live App](https://img.shields.io/badge/Web%20App-chemicalx.xophz.com-06b6d4?style=for-the-badge&logo=cloudflare)](https://chemicalx.xophz.com/) [![Parent Repo](https://img.shields.io/badge/Repository-awesome--secret--sauce-8b5cf6?style=for-the-badge)](https://github.com/Chemical-X-Protocol/awesome-secret-sauce) [![Benchmarks](https://img.shields.io/badge/Benchmarks-Agent%20Evaluations-10b981?style=for-the-badge)](https://github.com/Chemical-X-Protocol/benchmarks)

`chemx` 是一个命令行工具和 MCP 服务器。 AI 编码代理称它为生 `cat`, (中文(简体) ), `grep`, (中文(简体) ), `git`, (中文(简体) ), `npm test` 财务报告和审定财务报表 `tsc`,然后获得简短,结构化的答案。 几个代理可以共享一个退票而不互相覆盖.

> **如果你是人工智能特工的话:** 跳转到 [对于人工智能特工](https://npmcn.com/package/%40chemx/starter-kit/#readme-for-ai-agents)规则在 [一般事务人员(其他职等)](https://npmcn.com/package/%40chemx/starter-kit/AGENTS.md) 机器可读索引为 [页:1](https://npmcn.com/package/%40chemx/starter-kit/llms.txt)。 。 。 .

## 为什么它存在

| 没有化学 | 与化学 |
| :-- | :-- |
| 一个代理读取整个文件以找到一个函数 . | `chemx read file --symbol=name` 返回该函数. `--outline` 返回文件的形状. |
| `npm test` 财务报告和审定财务报表 `tsc` 打印每行过行. | `chemx verify` 打印一个状态卡,只有失败时的行. |
| 每个代理人自行决定其变化是否良好. | 一个审计规则在编辑器,承诺钩和任务门中运行. 在文档中添加违规内容的更改在任何地方都失败了 . |
| 两个代理编辑同一文件. | 文件锁定和任务生活在共享的 SQLite db ()`.chemx/index.db`) (中文(简体) ). `chemx commit` 拒绝您不持有的文件. |
| 重复的代码堆积起来 不被注意. | `chemx patterns` 查找值得提取的重复代码( 见 [限制](https://npmcn.com/package/%40chemx/starter-kit/#readme-limitations): 早期阶段). |

## 快速启动

```bash
npm install -g chemx          # Node 22.13.0 or later. Or: npx chemx <command>
chemx doctor                  # read-only check of install, PATH, MCP, hooks and index

chemx q "useCardController"                 # find a symbol from the index
chemx read src/card.ts --outline            # the shape of a file, not the whole file
chemx patch src/card.ts --target="oldCode" --replacement="newCode" --dry-run
chemx verify                                # audit + typecheck + tests, one short card
```

用克洛德密码? `chemx install-hooks --host=claude --dry-run` 显示将写给 `.claude/settings.json`投档 `--dry-run` 应用它。 它在下届会议上生效。 使用 Cursor, VS 代码还是反重力? `npx chemx install-mcp` 注册 MCP 服务器(参见 [MCP 服务器](https://npmcn.com/package/%40chemx/starter-kit/#readme-mcp-server)) (中文(简体) ).

开始一个新项目? `npm create chemx my-app -- --framework=vue` 脚手架一(`react`, (中文(简体) ), `vue` 或者说 `svelte`) (中文(简体) ).

## 它能做些什么

运行 `chemx help` 实时列表和 `chemx help <command>` 旗帜和例子。 以下各组与名单相符.

| 组 | 图标 | 你得到的东西 |
| :-- | :-- | :-- |
| **搜索和阅读** | `q`, (中文(简体) ), `read`, (中文(简体) ), `trace`, (中文(简体) ), `backtrace`, (中文(简体) ), `check` | AST 索引搜索 (`--hybrid`, (中文(简体) ), `--blast-radius`, (中文(简体) ), `--inspect`字义 `-g`),用大纲,符号或行域来读取,调用图表双向,一个文件规则检查. 每一个索引答案都以新鲜度章来结尾. |
| **编辑** | `patch`, (中文(简体) ), `write`, (中文(简体) ), `add`, (中文(简体) ), `explode`, (中文(简体) ), `generate` | 精确的文本补丁和完整文件写出检查结果的解析,报告新的审计违规行为(`introducedViolations`)和再指数. `add` 在胶囊上添加道具,状态或动作. `explode` 拆分一个大文件. `generate` 脚手架有胶囊. |
| **校验** | `verify`, (中文(简体) ), `test`, (中文(简体) ), `typecheck`, (中文(简体) ), `lint`, (中文(简体) ), `build`, (中文(简体) ), `audit`, (中文(简体) ), `trend`, (中文(简体) ), `badge`, (中文(简体) ), `docs` | 只有失败. `verify` 是审计+类型检查+测试. `audit` 对照7个支柱对代码进行分级. `trend` 显示计分历史, `badge` 写 SVG, `docs` 检查文档中命名的化学命令是否存在 . |
| **重构** | `patterns`, (中文(简体) ), `blueprint`, (中文(简体) ), `heal` | 查找重复的代码, 计划一次提取, 应用它, 如果任何检查失败, 则回滚 。 正在开发中. |
| **吉特和外壳包装** | `d`, (中文(简体) ), `show`, (中文(简体) ), `status`, (中文(简体) ), `log`, (中文(简体) ), `conflicts`, (中文(简体) ), `commit`, (中文(简体) ), `ci`, (中文(简体) ), `wait`, (中文(简体) ), `p`, (中文(简体) ), `f`, (中文(简体) ), `j`, (中文(简体) ), `do` | 绑定的 diff、 日志和 `package.json`, 文件查找器, JSON 形状, 路径限制的租赁检查承诺, 一个 PR 的检查, 并分批 几个命令在一个过程中. |
| **特工和群起攻击** | `team`, (中文(简体) ), `run`, (中文(简体) ), `project`, (中文(简体) ), `scratch`, (中文(简体) ), `worktree`, (中文(简体) ), `mutate`, (中文(简体) ), `report`, (中文(简体) ), `friction` | 任务,文件锁,DMs和一个feed. 每个任务等级的模型路由 和Claude代码工作流程用于建造、审查、修理和大门。 代理抓取干燥剂和工作树 成本报告。 警卫否认的记录. |
| **设置** | `init`, (中文(简体) ), `create`, (中文(简体) ), `pillars`, (中文(简体) ), `install-mcp`, (中文(简体) ), `hook`, (中文(简体) ), `doctor`, (中文(简体) ), `ui`, (中文(简体) ), `tesseract` | 解包蓝图 脚手架应用 配置规则 安装MCP和钩子 诊断问题 本地网络仪表板 代理上载简报. |

输出的形状和列表一样重要. 这些是真正的成果:

```
$ chemx verify
  ✔ AST Architecture:  A+ (100/100, 0 violations)
  ✔ TypeScript:        Clean (0 errors)
  ✔ Test Suite:        Passed (143/143)

$ chemx typecheck --json     # one minified line when it fails
{"success":false,"exitCode":2,"errorCount":1,"errors":["src/a.ts:1:7 TS2322 Type 'string' is not assignable to type 'number'."]}
```

## 如何运作

```
 agent / human ──► chemx CLI or MCP tool
                        │
        ┌───────────────┼────────────────┐
        ▼               ▼                ▼
   AST index        audit rules     team tables
   (symbols,        (7 pillars,     (tasks, locks,
   imports,          one gate        feed, token
   call graph)       rule)           costs)
        └───────────────┴────────────────┘
                 .chemx/index.db  (SQLite, one per monorepo)
```

-   **一一出门法.** 承诺前的钩子, `chemx verify`, (中文(简体) ), `chemx team task done` 财务报告和审定财务报表 `patch`编号 :`write` 当任何规则的违反数在文件里上升时,都失败了。 一个承诺接受的人不能变成另一个红色。 见 [文件/审计门](https://npmcn.com/package/%40chemx/starter-kit/docs/audit-gates.md)。 。 。 .
-   **锁是租赁.** 毒剂使用化学药剂时会更新 其他人等待时会停止更新 见 [文件/小组锁](https://npmcn.com/package/%40chemx/starter-kit/docs/team-locks.md)。 。 。 .
-   **chemx制作和检查;主机运行代理.** `chemx team dispatch --workflow` 写剧本。 Claude Code的工作流程工具运行它. `chemx team audit-run` 检查结果之后.

## 对于人工智能特工

-   **先读:** [一般事务人员(其他职等)](https://npmcn.com/package/%40chemx/starter-kit/AGENTS.md) 是条子规则书(门槛、支柱、协调协议). `CLAUDE.md` 财务报告和审定财务报表 `GEMINI.md` 是用来指示它的。 以 `chemx pillars --write`,不要手工编辑.
-   **上岗简报:** `chemx tesseract` 打印工程指标、7项指令和命令.
-   **一个MCP工具:** `chemx({ action, params })`。 。 。 . `{ "action": "help" }` 列出每个动作。 变异行动`write`, (中文(简体) ), `patch`, (中文(简体) ), `autofix`, (中文(简体) ), `generate`(小组索偿和员额) `params.projectRoot` 设置到绝对回波路径.
-   **默认循环 :** `chemx q` 寻找, `chemx read --outline` 或者说 `--symbol` 听着, `chemx patch` 要编辑, `chemx test --changed --depth=3` 在工作期间, `chemx verify` 在你写完之前.
-   **共享工作空间 :** 请求任务,锁定每个文件,小于 `chemx commit`,然后释放锁 `chemx team task done`细节 [文件/协调-db.md](https://npmcn.com/package/%40chemx/starter-kit/docs/coordination-db.md) 财务报告和审定财务报表 [文件/小组锁](https://npmcn.com/package/%40chemx/starter-kit/docs/team-locks.md)。 。 。 .
-   **护身钩:** claude Code中,钩子将原始的外壳工具向chemx方向引导,并可以屏蔽本地文件工具. 要绕过一个, 附加 `# chemx-bypass: <reason>`。绕行被记录为摩擦。 见 [文件/邮编](https://npmcn.com/package/%40chemx/starter-kit/docs/hooks.md)。 。 。 .

### MCP 服务器

`npx chemx install-mcp` 合并 a `chemical-x` 进入 `.cursor/mcp.json` 财务报告和审定财务报表 `.vscode/mcp.json` (编) `--global` 为抗重力。 保存现有服务器并保存为旧文件 `.bak`。用于 MCP 客户端的手动配置 :

```json
{ "mcpServers": { "chemical-x": { "command": "npx", "args": ["-y", "chemx", "mcp"] } } }
```

3个呼叫表: `{ "action": "read", "projectRoot": "/abs/repo", "params": { "path": "src/a.ts", "outline": true } }`,一个 CLI 字符串 `{ "command": "q useBrandingStore --blast-radius" }`,或批次 `{ "commands": ["d", "p -s", "verify"] }`。完整的合同(根解析度、书面拒绝、壳限、 stale-server通知)载于 [文件/参考资料.md](https://npmcn.com/package/%40chemx/starter-kit/docs/reference.md#the-chemx-mcp-tool)。 。 。 .

## 7个建筑支柱

审计强制执行这些要求. `chemx pillars` 每个项目打开或关闭.

1.  **分子项目预算.** 单功能文件; 在复杂度高时250行软警告,标出500以上.
2.  **零生地DOM.** Raw HTML 仅存在于原子内(`a-*`;分子由原子组成.
3.  **内容表视图.** 顶层取景为10至20行构成.
4.  **可混合合同.** 由可编成物返回参考物、计算和功能的平面对象,并自行清理.
5.  **寂静相验.** 验证通过 `chemx verify`, (中文(简体) ), `test` 财务报告和审定财务报表 `typecheck`,只打印失败.
6.  **AST 查询引擎.** 搜索和阅读索引,永远不要通过丢弃文件.
7.  **沼泽积压.** 任务、租赁和费用在SQLite中直播,而不是在减记文件中.

审计还发现了AI-slop文本("这里是代码", `// ... rest of implementation`), 模拟数据和假邮件, 泄露秘密, 吞下渔获量, 逐个规则的细节在 [文件/参考资料.md](https://npmcn.com/package/%40chemx/starter-kit/docs/reference.md#two-tier-decoupled-audit-pipeline)。 。 。 .

## 语文

| 语言 | 深度 |
| :-- | :-- |
| 类型脚本、 JavaScript、 Vue、 Svelte | AST全面审计 `@vue/compiler-sfc`),钩子合同,模板克隆检测 |
| Ưμ㼯A | AST审计外加WordPress规则(REST权限,非ce,可选入SQL,输入,输出). 见 [文献/php-wordpress.md](https://npmcn.com/package/%40chemx/starter-kit/docs/php-wordpress.md) |
| C# (韩语) | 结构模式:项目预算、空渔获量、内基 |
| Python,去,鲁斯 | 文本仅通过:行预算、斜坡、模拟数据、秘密、同义词、符号索引 |

任何其他文件类型都不审计 。 更广泛的语言适配层( :`cli/lang/`,与 `.chemxrc` `languages` 配置和 a `CHEMX_LANG_ENGINE=legacy` 正在分阶段推出。 没有配置,你得到上面的表.

## 限制

-   **福盖未完.** `patterns --forge` 其标注指标为65%,而目标为70%. `blueprint` 计划并编辑任何内容. `heal` 仅为与文库作品相匹配的团体工作,至今已治愈了一组.
-   **npm 落后主.** 这个 `chemx` npm 可在此仓库后面. `chemx --version` 告诉你哪栋楼是你的.
-   **升级后重新连接MCP.** 运行中的服务器保留它装入的代码, 报告 `stale chemx MCP server` 并按更慢的新程序运行每个调用,直到重新连接(`/mcp` 在克劳德代码.
-   **虎克是有限的建议.** 后卫读取命令文本. 它没有沙盒 一个脚本写文件本身.
-   **调度本身证明不多.** chemx制作脚本,然后检查运行。 它不能证明代理人完成了任务.
-   **短旗不验证.** 类型错误 `-x` 没有被抓住.

## 计量结果

每一个数字都是一个记录的运行,而不是一个基准套房,没有人预测你的项目.

| 结果 | 日期 | 来源 |
| :-- | :-- | :-- |
| 按大纲或符号阅读,而不是整个文件,每个目标节省了25%至97%,合计75%(10个目标) | 2026-10-09 (英语) | `pnpm bench`, (中文(简体) ), [基准/README.md](https://npmcn.com/package/%40chemx/starter-kit/benchmarks/README.md) |
| 1次调度:11次任务,29名代理,5.65美元对8.51美元在Opus定价,0次租赁失效,85.8%的工具通过chemx调用 | 2026-10-09 (英语) | `chemx team audit-run --run=wf_afacbbe8-24c`,提供#7240和#7241 |
| 10 053个工具电话的编目:6.13 M字符比37.92M返回原生反事实(减少83.8%) | 2026-10-09 (英语) | `tool_calls` 页:1 `.chemx/index.db` |

完整的表格 带有方法和复制步骤 [文件/参考资料.md](https://npmcn.com/package/%40chemx/starter-kit/docs/reference.md#measured-results)。 。 。 .

## 文件地图

| 需求 | 转到 |
| :-- | :-- |
| 每个有旗帜和实例的命令 | `chemx help <command>`, (中文(简体) ), [文件/参考资料.md](https://npmcn.com/package/%40chemx/starter-kit/docs/reference.md) |
| 所有参考页 | [文件/数据](https://npmcn.com/package/%40chemx/starter-kit/docs/INDEX.md) |
| 变了 | [文件/更改](https://npmcn.com/package/%40chemx/starter-kit/docs/CHANGELOG.md) |
| 规则和阈值 | [一般事务人员(其他职等)](https://npmcn.com/package/%40chemx/starter-kit/AGENTS.md), (中文(简体) ), [标准.md](https://npmcn.com/package/%40chemx/starter-kit/STANDARDS.md) |
| 派出一群人 | [文档/小组-发送](https://npmcn.com/package/%40chemx/starter-kit/docs/team-dispatch.md), (中文(简体) ), [文件/小组-审计-运行.md](https://npmcn.com/package/%40chemx/starter-kit/docs/team-audit-run.md) |
| 搜索和读取细节 | [文献/搜索.md](https://npmcn.com/package/%40chemx/starter-kit/docs/search.md), (中文(简体) ), [文件/索引新鲜度](https://npmcn.com/package/%40chemx/starter-kit/docs/index-freshness.md) |
| 试验道 | [文档/测试通道(md)](https://npmcn.com/package/%40chemx/starter-kit/docs/test-lanes.md) |
| 有东西坏了 | `chemx doctor`, (中文(简体) ), [医生/医生](https://npmcn.com/package/%40chemx/starter-kit/docs/doctor.md) |

## 隐私

审计,核查,搜索,阅读,补丁,生成和团队指令在网络上不发送任何信息. 只有四个明确的流量是:许可证下载(`init` 或者说 `create` 有钥匙的 执照折返检查, `audit --share` 错误报告 `--post-issue`。共享和错误报告首先打印其全部内容. `CHEMX_OFFLINE=1` 或者说 `DO_NOT_TRACK=1` 全部禁用 。 主机、已存储的文件和掩码规则都在 [文件/参考资料.md](https://npmcn.com/package/%40chemx/starter-kit/docs/reference.md#privacy--network)。 。 。 .

## 版本和许可证

版本为分精度CalVer(`YY.MM.DD-MMMM`)被CI撞伤. `create-chemx` 财务报告和审定财务报表 `chemx` 一起出版.

核心CLI工具和胶囊发电机获得麻省理工学院许可. 私人生产单机和扩展起动套房被解锁给经过验证的GitHub赞助商. 见 [化学文摘社.xophz.com](https://chemicalx.xophz.com/)。 。 。 .

## 常见问题

### @chemx/starter-kit 是什么？

化学 X 协议:私人落地式建筑启动装置和胶囊发生器

### 如何安装 @chemx/starter-kit？

在项目目录运行 npm install @chemx/starter-kit，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 chemx、chem-x、chemical-x、create-chemx，可以用 npx chemx 直接运行。

### @chemx/starter-kit 支持 TypeScript 吗？

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

### @chemx/starter-kit 支持 ESM 还是 CommonJS？

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

### @chemx/starter-kit 需要什么版本的 Node\.js？

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

### @chemx/starter-kit 可以商用吗？

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

### @chemx/starter-kit 的下载量有多少？

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

### @chemx/starter-kit 还在维护吗？

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