ComindX
GitHub 中
Install

Install Comobot with Four Supported Paths

Mac/Linux script, Windows script, Docker package, and source install are all available.

comobot — install 
# 官方脚本（自动判断网络，国内自动切镜像）
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/musenming/comobot/main/scripts/install.sh)"

# 国内镜像（GitHub 不可达时）
/bin/bash -c "$(curl -fsSL https://dl.comindx.com/scripts/install.sh)"

# 安装完成后启动
comobot gateway
# PowerShell（管理员）
irm https://raw.githubusercontent.com/musenming/comobot/main/scripts/install.ps1 | iex

# 国内镜像
irm https://dl.comindx.com/scripts/install.ps1 | iex

# 安装完成后启动
comobot gateway
curl -fsSL https://github.com/musenming/comobot/releases/latest/download/comobot-docker.zip -o comobot-docker.zip
unzip comobot-docker.zip && cd comobot-docker

# 启动服务（首次会拉取镜像，约 1-2 分钟）
docker compose up -d

# 查看运行状态
docker compose ps
git clone https://github.com/musenming/comobot.git
cd comobot

python3.11 -m venv .venv
source .venv/bin/activate        # Windows: .venv\Scripts\activate

pip install --upgrade pip setuptools wheel
pip install -e ".[dev]"

# 构建前端
cd web && npm install && npm run build && cd ..

# 启动
comobot gateway

Setup Guide

1. System Requirements

  • Mac / Linux: macOS 12+ or Ubuntu 20.04+ / Debian 11+
  • Windows: Windows 10 1903+ / Windows 11 (PowerShell 5.1+)
  • Docker path: local Docker Desktop environment

2. Onboarding

comobot onboard

Configure model and baseline settings (script install usually runs this for first-time setup).

3. Start Service

# 首次初始化
comobot onboard

# 启动服务
comobot gateway

After gateway starts, Comobot Web UI and API become available locally.

4. Docker Access

After Docker deployment, open http://localhost:18790 in your browser.

Data persists in Docker Volume comobot-data.

Chat Channel Integration

11 chat platforms supported. Click to expand setup guides.

Channel Type Status
Telegram IM Ready
Discord IM Ready
WhatsApp IM Ready
Feishu (Lark) IM Ready
Mochat IM Ready
DingTalk IM Ready
Slack IM Ready
Email IM Ready
QQ IM Ready
WeChat IM Ready
WeCom IM Ready
Matrix IM Ready
Telegram Create a bot via BotFather and plug in the token.
  1. Find @BotFather in Telegram
  2. Send /newbot to create a bot
  3. Add Bot Token to config.json
  4. Start comobot gateway
Discord Create a Discord Application with Bot and message intents enabled.
  1. Visit Discord Developer Portal
  2. Create Application → Bot
  3. Enable Message Content Intent
  4. Add Bot Token, start gateway
WhatsApp Connect via WhatsApp Business API or bridge.
  1. Install bridge deps: cd bridge && npm install
  2. Build bridge: npm run build
  3. Login: comobot channels login
  4. Scan QR code to bind
Feishu (Lark) Create an app in Feishu Open Platform with event subscriptions.
  1. Login to Feishu Open Platform
  2. Create enterprise app
  3. Configure message event subscription URL
  4. Add App ID and Secret
Mochat Self-hosted Mochat instant messaging integration.
  1. Deploy Mochat server
  2. Create Bot account
  3. Configure Webhook URL
  4. Start comobot gateway
DingTalk Create an internal enterprise app in DingTalk Open Platform.
  1. Login to DingTalk Open Platform
  2. Create internal enterprise bot
  3. Configure message callback URL
  4. Add AppKey and AppSecret
Slack Create a Slack App with Event Subscriptions enabled.
  1. Visit api.slack.com/apps
  2. Create New App → From Manifest
  3. Enable Event Subscriptions
  4. Install to Workspace, add Token
Email Connect via IMAP/SMTP protocols for email channel.
  1. Configure IMAP receive server
  2. Configure SMTP send server
  3. Add email account and auth code
  4. Start comobot gateway
QQ Create a bot app via QQ Open Platform.
  1. Login to QQ Open Platform
  2. Create bot application
  3. Configure sandbox for testing
  4. Get AppID and Token
WeChat Integrate a WeChat bot.
  1. Send a message to comobot: configure WeChat
  2. Get the QR code and scan it
  3. Reply with "Completed"
  4. Wait for comobot gateway to restart and verify message sending/receiving
WeCom Create a self-built app in WeCom admin console.
  1. Login to WeCom admin console
  2. Create self-built app
  3. Configure message receiving API
  4. Add CorpID and Secret
Matrix Connect to Matrix protocol, supporting Element and other clients.
  1. Install Matrix support: pip install -e ".[matrix]"
  2. Register Matrix account
  3. Get Access Token
  4. Configure Homeserver URL