@inoceanlee/brc

中文文档
2.1.2发布于 2026/11/01MITES Module

Unified Better Remote Commander service manager

原始使用文档
文档目录6 节
  1. Requirements
  2. Installation
  3. Common commands
  4. Configuration and data
  5. Uninstallation
  6. Development and contributing

Better Remote Commander (BRC)

Use your existing AI chat access to work on your own computer. BRC connects chat clients that support remote MCP (Model Context Protocol) to a self-hosted relay. You can manage files, run terminal commands, and inspect processes from a conversation.

Free chat allowances, such as ChatGPT's free tier, and chat allowances separate from coding-agent quotas, such as those in the Gemini ecosystem, are useful resources. BRC can put compatible chat access to work when the client supports remote MCP tools. Connector access depends on the platform and plan.

Based on shahidx0x/better-remote-commander.

Requirements

  • Windows x64 (tested on Windows 11).
  • Node.js 22.13 or newer and pnpm.
  • An HTTPS endpoint reachable by your chat client for remote access. Connect your public entry point to the local Traefik proxy.

BRC runs Relay, Traefik, and Agent locally. You manage the public HTTPS entry point separately.

Installation

Run these commands in PowerShell, in order.

1. Install BRC with pnpm.

pnpm add -g @inoceanlee/brc

2. Initialize BRC.

brc setup

Enter the administrator username (default: admin) and a password of at least eight characters. Setup creates the local configuration and installs Traefik.

3. Set the public URL for remote MCP access.

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

Point your HTTPS entry point to the local Traefik proxy at 127.0.0.1:13001. The URL must be the origin, without /mcp.

4. Start BRC and check its status.

brc start
brc status

On the first start, pair the Agent using the code and device verification page shown in its output or brc logs agent. Then add https://your-domain.example/mcp as a remote MCP server in a compatible chat client, such as ChatGPT or Claude, when supported by your plan.

Common commands

CommandPurpose
brc helpShow commands
brc startStart Relay, Traefik, and Agent
brc stopStop all managed services
brc restartRestart managed services
brc statusCheck service status
brc logs [relay|agent|traefik]Read service logs
brc config showShow effective settings
brc config get <key>Read a setting
brc config set <key> <value>Change a setting
brc config applyApply changes made to the YAML file
brc config pathShow the configuration file path
brc update traefikUpdate Traefik
brc cleanClean temporary runtime data

To upgrade the BRC package, run pnpm up -g @inoceanlee/brc --latest.

Configuration and data

BRC stores its configuration and runtime data under %LOCALAPPDATA%\BRC\ on Windows.

  • Configuration: %LOCALAPPDATA%\BRC\config\brc.yaml
  • Data, Traefik files, runtime state, and logs: subdirectories of %LOCALAPPDATA%\BRC\

Set BRC_DATA_ROOT to use a different root directory. Run brc config path or brc config show to find the file and inspect current settings.

Uninstallation

Run these steps in order.

1. Uninstall BRC's services and private data.

brc uninstall

Confirm the displayed data directory when prompted. This stops the managed services and removes BRC configuration, credentials, database, Traefik files, logs, and other data in its private directory.

2. Remove any remaining global pnpm package.

pnpm remove -g @inoceanlee/brc

brc uninstall currently also schedules pnpm package removal automatically after the CLI exits on Windows. Wait for that removal to finish before running the second command; it is normally already complete.

To remove the package while keeping BRC's stored data, run only pnpm remove -g @inoceanlee/brc. The public HTTPS entry point, such as Tailscale Funnel, remains under your separate management.

Development and contributing

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

Issues and pull requests are welcome in this repository. The source uses pnpm workspaces with separate CLI, Relay, Agent, and shared packages. See architecture for implementation details.

MIT license: LICENSE. Tool attribution: NOTICE.

版本与发布记录

@inoceanlee/brc 共发布 3 个版本,首次发布于 2026/11/01;过去 12 个月发布了 3 个版本。

版本发布日期距今
2.1.2latest2026/11/012 天前
2.1.12026/11/012 天前
0.0.0-stage2026/11/012 天前

关于 @inoceanlee/brc 的常见问题

@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 和提交记录判断。