Skip to content

Gateway API

Gateway 在 http://127.0.0.1:19836 暴露 HTTP 路由,编辑与安装等长过程通过 SSE 流式回传。以下为 CLI 模式的主要接口;字段以 packages/gateway/src 为准。

HTTP 路由

方法路由用途
GET/health健康检查,返回 executionMode 等状态
POST/selection提交 / 更新当前选区 SelectionContext
POST/setup/detect检测各 provider 的 CLI 安装与登录状态
POST/setup/install安装缺失的 CLI(输出经 SSE 回流)
POST/setup/login触发 OAuth 登录(授权 URL 经 SSE 回传)
POST/edit执行变更(Direct / Agent),CLI 输出经 SSE 回流
POST/session/:id/abort中止某次执行

MCP 模式下额外挂载 /bridge(WebSocket);CLI 模式不挂 /bridge。见 MCP 模式(旧)

请求示例

健康检查:

bash
curl http://127.0.0.1:19836/health
# → { "executionMode": "cli", "uptime": ... }

检测钉钉 CLI:

bash
curl -XPOST http://127.0.0.1:19836/setup/detect \
  -d '{"providers":["dingtalk"]}'

SSE 事件

长过程(安装 / 登录 / 编辑)以 SSE 事件推送,常见事件类型:

事件含义
setup:progressSetup 步骤进度(含授权 URL / code)
cli:outputCLI 的实时 stdout / stderr
selection:updated选区已更新
edit:applied变更执行成功
edit:error变更执行失败(含原始错误)

侧边栏据此驱动 Setup 向导进度、执行阶段标签与「执行结果」流式输出。

基于 MIT 许可发布