ChatRoom

Appearance

Getting Started ​

Install ​

ChatRoom requires Node.js 24.15.0 or newer and Git.

bash
npm install -g @zhanguym/chatroom
chatroom init
chatroom serve

Windows users can also use ChatRoom-Windows-Portable.

chatroom init creates the configuration file and uses ~/Projects as the default allowed workspace root. The directory is created automatically if needed.

Default configuration file locations by operating system:

  • Linux: ~/.config/chatroom/config.json (or $XDG_CONFIG_HOME/chatroom/config.json when XDG_CONFIG_HOME is set)
  • macOS: ~/Library/Application Support/ChatRoom/config.json
  • Windows: %APPDATA%\\ChatRoom\\config.json, typically C:\\Users\\<username>\\AppData\\Roaming\\ChatRoom\\config.json

Default local endpoints:

text
WebUI  http://127.0.0.1:8765/
MCP    http://127.0.0.1:8765/mcp

WebUI ​

The WebUI currently contains four main pages:

  • Workspace: Browse allowed projects, directories, files, skills, and Git.
  • Process: Inspect processes supervised by ChatRoom, including complete commands, output, and state.
  • Computer Control: View computer screenshots and operation records, and control the enable/disable switch.
  • Cloud: Purchase, restore, and manage ChatRoom Cloud.
  • Operations: View operations by plugin, including their input, output, and execution state.

Connect ChatGPT ​

ChatGPT must be able to reach ChatRoom's MCP endpoint. You can use ChatRoom Cloud directly from the built-in Cloud page, or use your own HTTPS deployment and configure auth.mcpPublicBaseUrl.

For your own HTTPS deployment, keep ChatRoom bound to the local loopback address where possible and publish it through your HTTPS setup.

To purchase the Cloud service, see ChatRoom Cloud.

See Use ChatRoom with ChatGPT for the current ChatGPT setup flow.