OpenMCP CLI Overview

OpenMCP CLI is focused on three top-level command groups:

• gateway: start/stop/check the Gateway service.
• webui: start/stop/check the Web UI service.
• mcp: connect to MCP servers and invoke MCP protocol operations.

Quick Start

# 1) Start Gateway first
omc gateway start -p 8282

# 2) Start Web UI (default static hosting mode)
omc webui start -p 8283 -g 8282

# 3) Check status
omc gateway status -p 8282
omc webui status -p 8283 -g 8282

Key Behavior Changes

• webui now requires subcommands (run | start | status | stop).
• webui and gateway are decoupled. webui will not auto-start/stop gateway.
• webui defaults to production static hosting. Use OPENMCP_WEB_DEV=1 to enable Vite dev mode.
• status/stop are robust with PID + port probing + health checks.
• Removed legacy top-level commands (especially rpc).

Next

• gateway command
• webui command
• mcp command
• migration notes

Contributors

PeaceSheep

Changelog

Last edited about 2 months ago

View full history

94875b6-refactor:更新web为webui

b1b16b0-feat(cli): 增加cli中gateway、web、mcp说明文档