Onboarding + Config Protocol

Mục đích: chia sẻ giao diện onboarding + config giữa CLI, macOS app và Web UI.

Các thành phần

  • Wizard engine (shared session + prompts + onboarding state).
  • CLI onboarding sử dụng cùng wizard flow như các UI clients.
  • Gateway RPC cung cấp các wizard + config schema endpoints.
  • macOS onboarding sử dụng wizard step model.
  • Web UI render các config forms từ JSON Schema + UI hints.

Gateway RPC

  • wizard.start params: { mode?: "local"|"remote", workspace?: string }
  • wizard.next params: { sessionId, answer?: { stepId, value? } }
  • wizard.cancel params: { sessionId }
  • wizard.status params: { sessionId }
  • config.schema params: {}

Responses (shape)

  • Wizard: { sessionId, done, step?, status?, error? }
  • Config schema: { schema, uiHints, version, generatedAt }

UI Hints

  • uiHints được đánh key theo path; metadata tùy chọn (label/help/group/order/advanced/sensitive/placeholder).
  • Các trường sensitive được render dưới dạng password inputs; không có redaction layer.
  • Các schema nodes không được hỗ trợ sẽ fallback về raw JSON editor.

Ghi chú

  • Tài liệu này là nơi duy nhất để theo dõi các protocol refactors cho onboarding/config.