# @inoceanlee/brc 中文文档

规范地址：https://npmcn.com/package/%40inoceanlee/brc/

版本：2\.1\.2
npm 元数据更新时间：2026-11-01T08:44:01.207Z
中文译文更新时间：2026-11-01T11:32:48.313Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40inoceanlee/brc
原文对照：https://npmcn.com/package/%40inoceanlee/brc/?lang=original

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

- 包体积（解压后）：165 MB，23797 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.13
- 运行依赖：39 个
- 首次发布：2026-11-01T05:52:42.700Z
- 最新版本发布：2026-11-01T08:44:01.043Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

统一的Better Remote Commander服务管理器

## 安装

```sh
npm install @inoceanlee/brc
```

也可以使用：`pnpm add @inoceanlee/brc`、`yarn add @inoceanlee/brc`、`bun add @inoceanlee/brc`

## README

# 优秀远程指挥官（BRC）

使用你现有的AI聊天访问在你自己的电脑上工作。BRC将支持远程MCP（模型上下文协议）的聊天客户端连接到自托管中继。您可以管理文件，运行终端命令，并从对话中检查进程。

免费聊天额度，比如ChatGPT的免费层，以及与编码代理配额分离的聊天额度，比如Gemini生态系统中的那些，都是有用的资源。当客户端支持远程MCP工具时，BRC可以使兼容的聊天访问工作。连接器访问取决于平台和计划。

基于 [shahidx0x / better-remote-commander](https://github.com/shahidx0x/better-remote-commander).

## 要求

-   Windows x64（在Windows 11上测试）。
-   Node.js 22.13或更新版本和pnpm。
-   聊天客户端可访问的HTTPS端点，用于远程访问。将公共入口点连接到本地Traefik代理。

BRC在本地运行Relay、Traefik和Agent。您单独管理公共HTTPS入口点。

## 安装

按顺序在PowerShell中运行这些命令。

**1\. 使用pnpm安装BRC。**

```powershell
pnpm add -g @inoceanlee/brc
```

**2\. BRC进行初始化。**

```powershell
brc setup
```

输入管理员用户名(默认为： `admin`)和至少8个字符的密码。安装程序创建本地配置并安装Traefik。

**3\. 设置公共URL** 用于远程MCP访问。

```powershell
brc config set services.publicUrl https://your-domain.example
```

将您的HTTPS入口点指向本地Traefik代理 `127.0.0.1:13001`． URL必须是源，没有 `/mcp`.

**4\. 启动BRC，检查BRC状态。**

```powershell
brc start
brc status
```

第一次启动时，使用输出或中显示的代码和设备验证页面对Agent进行配对 `brc logs agent`． 然后添加 `https://your-domain.example/mcp` 作为兼容聊天客户端的远程MCP服务器，如ChatGPT或Claude，如果您的计划支持的话。

## 常用命令

| 命令 | 目的 |
| --- | --- |
| `brc help` | 显示命令 |
| `brc start` | 启动Relay、Traefik和Agent |
| `brc stop` | 停止所有托管服务 |
| `brc restart` | 重新启动托管服务 |
| `brc status` | 检查服务状态 |
| `brc logs [relay|agent|traefik]` | 读取业务日志 |
| `brc config show` | 显示有效设置 |
| `brc config get <key>` | 阅读设置 |
| `brc config set <key> <value>` | 更改设置 |
| `brc config apply` | 将更改应用到YAML文件 |
| `brc config path` | 显示配置文件路径 |
| `brc update traefik` | 更新Traefik |
| `brc clean` | 清理临时运行时数据 |

升级BRC包，执行命令 `pnpm up -g @inoceanlee/brc --latest`.

## 配置和数据

下存储其配置和运行时数据 `%LOCALAPPDATA%\BRC\` 在Windows上。

-   配置: `%LOCALAPPDATA%\BRC\config\brc.yaml`
-   “Data”、“Traefik”文件、“运行状态”和“日志”：“。”的子目录 `%LOCALAPPDATA%\BRC\`

集 `BRC_DATA_ROOT` 使用不同的根目录。运行 `brc config path` 或者 `brc config show` 查找文件并检查当前设置。

## 卸载

按顺序运行这些步骤。

**1\. 卸载BRC的服务和私人数据。**

```powershell
brc uninstall
```

根据提示确认显示的数据目录。这将停止托管服务并删除其私有目录中的BRC配置、凭据、数据库、Traefik文件、日志和其他数据。

**2\. 删除所有剩余的全局pnpm包。**

```powershell
pnpm remove -g @inoceanlee/brc
```

`brc uninstall` 目前还在Windows上调度命令行退出后自动删除pnpm包。等待删除完成后再运行第二个命令；它通常已经完成了。

要删除包，同时保留BRC存储的数据，只运行 `pnpm remove -g @inoceanlee/brc`． 公共HTTPS入口点（如Tailscale Funnel）仍然由您单独管理。

## 发展和贡献

```powershell
git clone https://github.com/inoceanlee/better-remote-commander.git
cd better-remote-commander
pnpm install
pnpm build
pnpm test
```

在这个存储库中欢迎发布和拉取请求。源代码使用带有独立CLI、Relay、Agent和共享包的pnpm工作区。看到 [体系结构](https://github.com/inoceanlee/better-remote-commander/blob/main/docs/architecture.md) 有关实现细节。

MIT许可: [许可证](https://github.com/inoceanlee/better-remote-commander/blob/main/LICENSE)． 工具归因: [请注意](https://github.com/inoceanlee/better-remote-commander/blob/main/NOTICE).

## 常见问题

### @inoceanlee/brc 是什么？

统一的Better Remote Commander服务管理器

### 如何安装 @inoceanlee/brc？

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

### @inoceanlee/brc 支持 TypeScript 吗？

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

### @inoceanlee/brc 支持 ESM 还是 CommonJS？

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

### @inoceanlee/brc 需要什么版本的 Node\.js？

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

### @inoceanlee/brc 可以商用吗？

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

### @inoceanlee/brc 还在维护吗？

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