# nota-bene-ide 中文文档

规范地址：https://npmcn.com/package/nota-bene-ide/

版本：1\.4\.0
npm 元数据更新时间：2026-11-04T07:51:51.422Z
中文译文更新时间：2026-11-04T08:22:37.455Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/nota-bene-ide
原文对照：https://npmcn.com/package/nota-bene-ide/?lang=original
项目主页：https://github.com/iCubeDm/nota-bene-ide#readme
源码仓库：https://github.com/iCubeDm/nota-bene-ide

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

- 包体积（解压后）：9.1 MB，83 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2026-10-30T20:46:07.929Z
- 最新版本发布：2026-11-04T07:51:51.065Z
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

一个浏览器IDE克劳德代码和Codex：代理聊天，内行边距评论发送为一个批次，一个文件树和查看器。

## 安装

```sh
npm install nota-bene-ide
```

也可以使用：`pnpm add nota-bene-ide`、`yarn add nota-bene-ide`、`bun add nota-bene-ide`

## README

![Nota Bene](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/web/public/icon-512.png)

# 留心

浏览器IDE over [克劳德代码](https://claude.com/claude-code) 和 [食典委](https://openai.com/codex/)，使用Claude Agent SDK或本地Codex应用服务器。它将您所选择的代理带入一个用于审查和监督流程的窗口：选择回复或文件的任何片段，在空白处留下注释，并将所有注释作为一个批次发送给代理。该窗口还具有文件树、代码、图像、视频和音频查看器以及会话选择器。

![Selecting text in a reply, adding a comment and sending it](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/annotate-text.gif)

## 安装

您需要Node.js 22或更新版本，并且您选择的代理已安装并登录：Claude Code或Codex CLI 0.166.0或更新版本。第一次运行下载大约330 MB，其中大部分是Agent SDK的二进制文件（通过Codex插件大约70 MB，它跳过了它们）。

作为Claude Code插件（推荐）。在《克劳德法典》中：

```
/plugin marketplace add iCubeDm/nota-bene-ide
/plugin install nota-bene@nota-bene
```

然后，在任何项目文件夹中：

```
/nb
```

第一个 `/nb` 安装 `nota-bene-ide` NPM包放到插件的data文件夹中，然后在浏览器中打开这个窗口。插件的技能是 `/nota-bene:nb`;裸露的 `/nb` 只要其他技能没有这个名字就行。

或者在终端上，不带插件：

```sh
cd your-project
npx nota-bene-ide

# or install the command once
npm i -g nota-bene-ide
nota-bene
```

## Codex / ChatGPT

Codex支持使用已安装的 **Codex CLI 0.166.0或更新版本** 通过它的原生 `app-server`． 登录的ChatGPT帐户 `codex login` 是充分的;留心 不读取身份验证文件或需要单独的API密钥。现有的配置 api密钥帐户也使用本机运行时。

打开一个提供程序绑定的窗口 `nota-bene . --agent codex --detach`． 默认的 没有 `--agent` 仍然是克劳德。每个提供程序都有独立的窗口和保存 设置;两者都可以在同一个项目中运行。法典中的模型、技能和会议 窗户来自法典。不要在另一个客户端继续相同的对话 而窗户拥有它；在进行CLI/Desktop会话时使用fork。

从终端安装Codex插件：

```sh
codex plugin marketplace add iCubeDm/nota-bene-ide --ref main
codex plugin add nota-bene@nota-bene
```

该插件提供 `$nb`， `$nb new`, `$nb fork`． 第一次使用它下载 `nota-bene-ide@1.4.0` （大约70 MB，不含Claude Code二进制文件）；后来 启动时重用npm的缓存。没有全局npm 需要安装或手动复制。Node.js、npm和一个已登录的Codex CLI 必须已经可用。这是一个面向本地法典客户的存储库市场， 不是公共ChatGPT插件目录中的列表。

或者，使用 `npm i -g nota-bene-ide@1.4.0`，然后问 法典安装刚刚的技能。如果您只使用Codex，请添加 `--omit=optional` 跳过 克劳德代码二进制；克劳德窗口无法从该安装启动。

```text
$skill-installer Install the nb skill from https://github.com/iCubeDm/nota-bene-ide/tree/main/codex/skills/nb
```

对于源代码开发，请链接 `codex/skills/nb` 成 `~/.agents/skills/nb` 只有在 这个目的地并不存在。一个独立复制的技能使用启动器 捆绑在它的NPM包或安装的 `nota-bene` 在路径。

重新加载技能或 重新启动法典，然后调用 `$nb`， `$nb new`,或 `$nb fork` (或在 桌面技能选择器)。桌面使用监督分离的生命周期：完成聊天 转动不关闭窗户。使用窗口中的Stop来关闭它。CLI可以保持 拥有的后台进程。 `fork` 需要实际调用主机的线程id； 没有它，帮助者显然失败了。一个已经打开的窗口被打开， 而不将请求的new/fork应用到会话中。

看到 [法典支持和限制](https://github.com/iCubeDm/nota-bene-ide/blob/main/docs/guide.md#codex-support) 为支持 行为和API限制。现有的Claude适配器和nb技能是 不变。ACP仍然是同一个AgentBackend接口后面的未来后端。

## 支持

|  | 状态 |
| --- | --- |
| 代理 | Claude Code（默认），Codex CLI /本地桌面 |
| macOS | 测试 |
| Linux | 在CI中通过单元测试；不是日常使用的 |
| 窗户 | 不支持( `/nb` 技能是一个bash脚本) |

## 快速启动

1.  运行 `/nb` (或 `nota-bene`)在项目文件夹中。已登录的窗口打开。
2.  问代理人一些问题。当回复到达时，选择其中的一个句子并按下 **评论**． 输入注释并按Cmd/Ctrl+Enter添加它。
3.  打开文件 **文件** 面板，选择一行代码，并对其进行注释。从每个回复和文件收集的评论 **评论** 面板。
4.  新闻 **发送(2)**． 代理会收到一条消息，其中列出了每个带有您的注释的片段。

代码也是如此：

![Commenting on a line of code](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/annotate-code.gif)

在图像上，你在图片上画图，标记的图片进入代理：

![Marking up an image](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/annotate-image.gif)

在一段视频的单帧中：

![Marking up a video frame](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/annotate-video.gif)

## 特性

-   与Claude Code或Codex聊天。在代理工作时发送的消息被注入到运行回合中；Cmd/Ctrl+Enter将中断座席并发送。
-   保证金评论的任何回复，在您自己的消息和任何打开的文件，作为一个批次发送。11个一键式标签（Looks good、Clarify this、Verify this等）。
-   用矩形、椭圆、笔或箭头在图像和视频帧上进行标记，并对所标记的帧进行注释。
-   文件树和查看器：带有搜索功能的标记、高亮代码、图像、视频和音频。在聊天中呈现美人鱼和SVG图。
-   手动编辑文本文件，而不覆盖同时在磁盘上所做的更改。
-   头文件中的Git：一个在其他工作树和分支上的分支选择器，一个Changes视图和Git日志，都是只读的。
-   `@` 提到一个文件， `/` 打开代理的命令和技能， `!` 在项目文件夹中运行shell命令。
-   子代理对话在它们自己的选项卡中，以及一个用于后台任务的抽屉。
-   任何文件夹中的会话，对话的分支，每次压缩之前的历史。
-   代理权限模式、模型和工作量、上下文和计划限制表。
-   使用标签：每个项目和代理的令牌，限制点击和之前的花费，额外的使用。
-   每个窗口的系统事件的审计日志（从来不是任何人写的），用于以后找出为什么一个回合停止了。
-   英语，俄语，简体中文，西班牙语，巴西葡萄牙语和德语界面。

![The window: chat, file tree and comments panel](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/overview.png)

![The slash menu](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/slash-menu.png)

![A Codex window: model, approval card, sandbox profile and account limits](https://raw.githubusercontent.com/iCubeDm/nota-bene-ide/main/docs/media/codex.png)

## 更新到1.4.0

对于终端安装，运行 `npm i -g nota-bene-ide@1.4.0`． 对于Claude插件， 通过Claude Code更新市场和安装插件。关上旧窗户 并再次启动以使用新包。现有的克劳德状态保持不变；食典委 使用自己的状态目录。看到 [发布说明](https://github.com/iCubeDm/nota-bene-ide/blob/main/CHANGELOG.md)。

## 指南

启动选项，每个特性都有一个示例，安全模型，其中保存状态和故障排除： [该指南](https://github.com/iCubeDm/nota-bene-ide/blob/main/docs/guide.md)． 它是如何建造的： [体系结构](https://github.com/iCubeDm/nota-bene-ide/blob/main/docs/architecture.md)。

## 执照

apache - 2.0。看到 [许可证](https://github.com/iCubeDm/nota-bene-ide/blob/main/LICENSE) 和 [THIRD-PARTY-NOTICES.md](https://github.com/iCubeDm/nota-bene-ide/blob/main/THIRD-PARTY-NOTICES.md)。

## 常见问题

### nota-bene-ide 是什么？

一个浏览器IDE克劳德代码和Codex：代理聊天，内行边距评论发送为一个批次，一个文件树和查看器。

### 如何安装 nota-bene-ide？

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

### nota-bene-ide 支持 TypeScript 吗？

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

### nota-bene-ide 支持 ESM 还是 CommonJS？

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

### nota-bene-ide 需要什么版本的 Node\.js？

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

### nota-bene-ide 可以商用吗？

nota-bene-ide 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### nota-bene-ide 还在维护吗？

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