快速开始
安装
ChatRoom 需要 Node.js 24.15.0 或更高版本以及 Git。
bash
npm install -g @zhanguym/chatroom
chatroom init
chatroom serveWindows用户也可以使用ChatRoom-Windows-Portable。
chatroom init 会创建配置文件,并默认使用 ~/Projects 作为允许访问的工作区根目录。目录不存在时会自动创建。
各系统默认配置文件位置:
- Linux:
~/.config/chatroom/config.json(设置了XDG_CONFIG_HOME时为$XDG_CONFIG_HOME/chatroom/config.json) - macOS:
~/Library/Application Support/ChatRoom/config.json - Windows:
%APPDATA%\\ChatRoom\\config.json,通常为C:\\Users\\<用户名>\\AppData\\Roaming\\ChatRoom\\config.json
默认本地地址:
text
WebUI http://127.0.0.1:8765/
MCP http://127.0.0.1:8765/mcpWebUI
WebUI 目前包含四个主要页面:
- 工作区:浏览允许访问的项目、目录、文件、Skill和Git。
- 进程:查看 ChatRoom 托管的进程、完整命令、输出和状态。
- 电脑控制: 查看电脑屏幕截图,操作记录,控制开关。
- Cloud:购买、恢复和管理 ChatRoom Cloud。
- 操作日志:按插件查看操作及其输入、输出和执行状态。
接入 ChatGPT
ChatGPT 必须能够访问 ChatRoom 的 MCP Endpoint。可以直接在内置 Cloud 页面使用 ChatRoom Cloud,也可以使用自己的 HTTPS 部署并配置 auth.mcpPublicBaseUrl。
自行部署 HTTPS 时,建议尽量让 ChatRoom 保持监听本机回环地址,并通过自己的 HTTPS 配置对外提供访问。
若需要购买 Cloud 服务,可以参见ChatRoom Cloud。
当前 ChatGPT 接入方式见在 ChatGPT 中使用 ChatRoom。