ComindX | Use

Global Options

comobot --version, -v

Show current version

comobot --help

Show help information

Command Overview

Command	Description
`comobot onboard`	Initialize config and workspace
`comobot agent`	Interactive agent chat
`comobot gateway`	Start gateway (API + Web + Channels)
`comobot gateway restart`	Restart gateway (background)
`comobot channels status`	Show channel status
`comobot channels login`	Link device via QR code
`comobot status`	Show comobot status
`comobot update`	Auto-update to latest version
`comobot uninstall`	Uninstall comobot
`comobot stats`	Show GitHub Release download stats
`comobot provider login`	OAuth login for LLM providers

Command Details

comobot onboard

Initialize comobot configuration and workspace.

comobot onboard

Creates ~/.comobot/config.json (option to overwrite or refresh if exists)
Creates ~/.comobot/workspace/ and syncs templates
Prompts to configure API key after completion

comobot agent

Chat with the agent interactively or send a single message.

comobot agent                        # Interactive chat
comobot agent -m "Hello!"           # Send a single message
comobot agent -s "my-session"       # Specify session ID
comobot agent --no-markdown         # Disable Markdown rendering
comobot agent --logs                # Show runtime logs

Option	Description
`-m, --message`	Send a single message (non-interactive)
`-s, --session`	Session ID (default `cli:direct`)
`--markdown / --no-markdown`	Toggle Markdown rendering (default on)
`--logs / --no-logs`	Toggle runtime log display

comobot gateway

Start the comobot gateway with FastAPI, Web console, and channel connections.

comobot gateway                     # Default port 18790
comobot gateway -p 8080             # Custom port
comobot gateway -v                  # Verbose logging

Option	Description
`-p, --port`	Gateway port (default `18790`)
`-v, --verbose`	Verbose log output

Automatically opens the Web console at http://localhost:<port>.

comobot gateway restart

Restart the gateway process (stops old process, starts new one in background).

comobot gateway restart
comobot gateway restart -p 8080 -v

comobot channels status

View enable status and configuration for all channels.

comobot channels status

Displays status for WhatsApp, Discord, Feishu, Telegram, Slack, DingTalk, QQ, WeChat, Matrix, Email, and more.

comobot channels login

Link a device via QR code.

comobot channels login              # Default: WhatsApp
comobot channels login whatsapp
comobot channels login wechat

comobot status

View comobot configuration and runtime status.

comobot status

Config file path and existence
Workspace path and existence
Current model
API key status for each LLM provider

comobot update

Auto-detect installation method and update to the latest version.

comobot update                      # Interactive confirmation
comobot update -y                   # Skip confirmation

Option	Description
`-y, --yes`	Skip confirmation prompt

Auto-detected installation methods:

Method	Detection	Update Strategy
Docker	Detects `/.dockerenv` or cgroup	`docker pull`
Binary	PyInstaller runtime or `~/.comobot/bin/`	Download from GitHub Releases
pip	None of the above	`pip install --upgrade`

Supported platforms: macOS (arm64/x64), Linux (arm64/x64), Windows (x64).

comobot uninstall

Uninstall comobot from this machine.

comobot uninstall                   # Remove binary and PATH only
comobot uninstall --all             # Also remove all data
comobot uninstall -y                # Skip confirmation

Option	Description
`--all`	Also delete all data under `~/.comobot/`
`-y, --yes`	Skip confirmation prompt

comobot stats

Show GitHub Release download statistics.

comobot stats

comobot provider login

Authenticate with an LLM provider via OAuth.

comobot provider login openai-codex
comobot provider login github-copilot

Supported OAuth providers:

openai-codex — OpenAI Codex (via oauth-cli-kit)
github-copilot — GitHub Copilot (device authorization flow)