# @bunshin-cc/bunshin 中文文档

规范地址：https://npmcn.com/package/%40bunshin-cc/bunshin/

版本：0\.11\.3
npm 元数据更新时间：2026-11-03T02:55:38.400Z
中文译文更新时间：2026-11-08T20:30:59.316Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：647 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-09-20T09:24:10.590Z
- 最新版本发布：2026-11-03T02:55:37.804Z
- 近 30 天下载量：2390（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 41 个）

## 中文简介

共享公司AI代理的记忆. 连接Codex,克洛德代码,或Pi到Bunshin.

## 安装

```sh
npm install @bunshin-cc/bunshin
```

也可以使用：`pnpm add @bunshin-cc/bunshin`、`yarn add @bunshin-cc/bunshin`、`bun add @bunshin-cc/bunshin`

## README

# 邦兴

Bunshin让你公司的AI代理(和机器人)互相学习. 您的 SPEC. md 、 TESTING. md 和 SKILL. md 、 其他团队的规则, 以及早期学习到的东西, 当它们重要时会到达代理人手中; 学习到的是什么会在当地尝试, 然后审查并分享.

## 连接工程

你需要20号或以后的Node.js,一个签名的Codex, Claude Code,或者Pi安装, 以及你公司的账户 [Bunshin 工作空间](https://bunshin.cc/dashboard/)。 。 。 .

```sh
npm install -g @bunshin-cc/bunshin
cd /path/to/your/project
bunshin setup --harness codex
```

在邦信,打开 **代理密钥** 并创建此计算机的密钥。 把它粘入隐藏的设置提示中 。 设置读取您来自工作空间的角色,团队,和权限,将密钥保存在项目外的私人文件中,并配置项目钩子(Codex为5个,Claude Code为6个外加一个MCP服务器). 它不需要单独的 API 模型密钥 .

运行 `codex` 在同一项目中互动。 立即审查和接受项目信任,然后运行 `/hooks` 并检讨并信任五道邦申钩. 项目信任和钩子信任是不同的步骤。 若为 `/hooks` 不列出 Bunshin, 请检查您是否打开了连接的工程并信任其配置 。 本指南测试交互式会议; `codex exec` 无法取代此设置检查.

对于一个链接到的Git工作树,设置将Codex钩子放入主检出,由Codex读取. 打印路径可以识别共享的钩子文件 。 每个相连的活树都保留着自己 `.bunshin` 商店和私人连接。 尚未支持从光线寄存器创建的工作树; 使用一个完整的检出 .

对于克洛德代码,使用 `bunshin setup --harness claude-code`,然后在项目中开始一个新的会话,并批准 `bunshin` 它添加到的 MCP 服务器 `.mcp.json` (它给模型 `bunshin_recall` 财务报告和审定财务报表 `bunshin_load` 页:1. `/learn` 在克劳德代码插件中,或 `bunshin learn "<what to remember>"`,按要求获取知识.

要连接整个项目文件夹( 每个项目库), 请运行其中的设置 `--hooks user`: 钩子在您的用户设置中运行, 在该文件夹下的每一会话都会使用它的工作空间, 而其它会话则未受影响 . `bunshin sources` 显示和更改其文件夹中哪些文件夹参加(`exclude <folder>`, (中文(简体) ), `only <folders…>`, (中文(简体) ), `include <folder>`, (中文(简体) ), `all`) (中文(简体) ).

用于 Pi, 使用22.19节点或以后运行 `bunshin setup --harness pi`中安装工程扩展 `.pi/extensions/bunshin.js`。在项目中启动 Pi(或运行) `/reload` 项目资源审查,并检查 `/bunshin status`。此 npm 包中的扩展船; 您不需要第二个包或寄存器.

## 检查它的工作原理

```sh
bunshin status
bunshin sync --json
bunshin index
bunshin recall "changing a state transition other teams depend on" --hypothetical "the owning team must approve first"
```

`bunshin index` 显示 repo 的文档如何被分割成若干个区块, 以及每个区块的路径 。 所学到的知识是在真实的会话之后到达的:当一个会话值得它的时候,反射会一直到它的结尾(对于克洛德代码,作为会话的分叉,所以它重复了即时缓存). 未自动应用的建议 `bunshin review`。 。 。 .

## 保持当前状态

钩子随谁跑 `bunshin` 已安装;没有为您更新。 最多每天一次,会话开始检查npm的更新版本,如果有,则在当天告诉你一次(`npm i -g @bunshin-cc/bunshin@latest`) (中文(简体) ). 设定 `BUNSHIN_NO_UPDATE_CHECK=1` 关闭支票.

0.6.2之前由CLI上传的会话带有被剪切的痕迹(最多为6万个字符). 更新后, `bunshin sync --retrace` 重新发送过去30天的`--days N`只要会话记录文件还在机器上.

`bunshin demo` 使用临时合成数据运行离线示例。 它不会验证您的工作空间连接或自动学习 .

## 范围和删除

设置适用于当前项目. 当地 `.bunshin/` 目录包含经验教训和会话状态,并添加到 `.gitignore`键存储在 `~/.config/bunshin/credentials/` 仅限所有者权限。 汝所现钩还住.

```sh
bunshin init --harness codex --remove-hooks
npm uninstall -g @bunshin-cc/bunshin
```

使用 `--harness claude-code` 删除 Claude 代码钩或 `--harness pi` 以删除 Pi 扩展。 断开Bunshin的这台电脑的密钥时, 取消它 。 取出钩子可保留本地课程.

代码钩被共享到一个寄存器连接的工作树上. 把它们从一个中去掉 将所有工作树上的 Bunshin 钩子都取出 其他工具的钩被保存.

完整的设置指南 : [bunshin.cc/文档](https://bunshin.cc/docs/)。 。 。 .

## 常见问题

### @bunshin-cc/bunshin 是什么？

共享公司AI代理的记忆\. 连接Codex,克洛德代码,或Pi到Bunshin\.

### 如何安装 @bunshin-cc/bunshin？

在项目目录运行 npm install @bunshin-cc/bunshin，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 bunshin、git-remote-bunshin，可以用 npx bunshin 直接运行。

### @bunshin-cc/bunshin 支持 TypeScript 吗？

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

### @bunshin-cc/bunshin 支持 ESM 还是 CommonJS？

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

### @bunshin-cc/bunshin 需要什么版本的 Node\.js？

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

### @bunshin-cc/bunshin 可以商用吗？

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

### @bunshin-cc/bunshin 的下载量有多少？

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

### @bunshin-cc/bunshin 还在维护吗？

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