mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-18 05:20:48 +00:00
a3ec2d0734
What: - update zh-CN glossary, TM, and translator prompt - regenerate zh-CN docs and apply targeted fixes - add zh-CN AGENTS pipeline guidance Why: - address terminology/spacing feedback from #6995 Tests: - pnpm build && pnpm check && pnpm test
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
---
|
||
read_when: Changing onboarding wizard steps or config schema endpoints
|
||
summary: 新手引导向导和配置模式的 RPC 协议说明
|
||
title: 新手引导和配置协议
|
||
x-i18n:
|
||
generated_at: "2026-02-03T07:47:10Z"
|
||
model: claude-opus-4-5
|
||
provider: pi
|
||
source_hash: 55163b3ee029c02476800cb616a054e5adfe97dae5bb72f2763dce0079851e06
|
||
source_path: experiments/onboarding-config-protocol.md
|
||
workflow: 15
|
||
---
|
||
|
||
# 新手引导 + 配置协议
|
||
|
||
目的：CLI、macOS 应用和 Web UI 之间共享的新手引导 + 配置界面。
|
||
|
||
## 组件
|
||
|
||
- 向导引擎（共享会话 + 提示 + 新手引导状态）。
|
||
- CLI 新手引导使用与 UI 客户端相同的向导流程。
|
||
- Gateway 网关 RPC 公开向导 + 配置模式端点。
|
||
- macOS 新手引导使用向导步骤模型。
|
||
- Web UI 从 JSON Schema + UI 提示渲染配置表单。
|
||
|
||
## Gateway 网关 RPC
|
||
|
||
- `wizard.start` 参数：`{ mode?: "local"|"remote", workspace?: string }`
|
||
- `wizard.next` 参数：`{ sessionId, answer?: { stepId, value? } }`
|
||
- `wizard.cancel` 参数：`{ sessionId }`
|
||
- `wizard.status` 参数：`{ sessionId }`
|
||
- `config.schema` 参数：`{}`
|
||
|
||
响应（结构）
|
||
|
||
- 向导：`{ sessionId, done, step?, status?, error? }`
|
||
- 配置模式：`{ schema, uiHints, version, generatedAt }`
|
||
|
||
## UI 提示
|
||
|
||
- `uiHints` 按路径键入；可选元数据（label/help/group/order/advanced/sensitive/placeholder）。
|
||
- 敏感字段渲染为密码输入；无脱敏层。
|
||
- 不支持的模式节点回退到原始 JSON 编辑器。
|
||
|
||
## 注意
|
||
|
||
- 本文档是跟踪新手引导/配置协议重构的唯一位置。
|