安裝引導 + 設定協定
用途:在 CLI、macOS 應用程式和 Web UI 之間共用安裝引導與設定介面。
元件
- 精靈引擎(共用的 session + 提示 + 安裝狀態)。
- CLI 安裝引導使用與 UI 用戶端相同的精靈流程。
- Gateway RPC 提供精靈 + 設定 schema 端點。
- macOS 安裝引導使用精靈步驟模型。
- Web UI 依據 JSON Schema + UI hints 呈現設定表單。
Gateway RPC
wizard.start參數:{ mode?: "local"|"remote", workspace?: string }wizard.next參數:{ sessionId, answer?: { stepId, value? } }wizard.cancel參數:{ sessionId }wizard.status參數:{ sessionId }config.schema參數:{}config.schema.lookup參數:{ path }path支援標準設定路徑段以及以斜線分隔的外掛 ID,例如plugins.entries.pack/one.config。
回應格式
- 精靈:
{ sessionId, done, step?, status?, error? } - 設定 schema:
{ schema, uiHints, version, generatedAt } - 設定 schema 查詢:
{ path, schema, hint?, hintPath?, children[] }
UI Hints
uiHints以路徑為鍵;選用的詮釋資料(label/help/group/order/advanced/sensitive/placeholder)。- 標記為敏感的欄位以密碼輸入呈現;不設遮蔽層。
- 不支援的 schema 節點退回至原始 JSON 編輯器。
備註
- 本文件是追蹤安裝引導/設定相關協定重構的唯一出處。