Giao thức Onboarding + Cấu hình

Mục đích: giao diện onboarding + cấu hình được chia sẻ qua CLI, ứng dụng macOS và Web UI.

Thành phần

  • Engine wizard (phiên được chia sẻ + prompt + trạng thái onboarding).
  • CLI onboarding sử dụng cùng luồng wizard như UI client.
  • Gateway RPC hiển thị endpoint wizard + schema cấu hình.
  • macOS onboarding sử dụng mô hình bước wizard.
  • Web UI render form cấu hình từ JSON Schema + gợi ý UI.

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: {}

Phản hồi (shape)

  • Wizard: { sessionId, done, step?, status?, error? }
  • Schema cấu hình: { schema, uiHints, version, generatedAt }

Gợi ý UI

  • uiHints được đặt key theo đường dẫn; metadata tùy chọn (label/help/group/order/advanced/sensitive/placeholder).
  • Trường nhạy cảm render như input mật khẩu; không có lớp redaction.
  • Node schema không được hỗ trợ quay về trình chỉnh sửa JSON raw.

Lưu ý

  • Tài liệu này là nơi duy nhất để theo dõi các refactor giao thức cho onboarding/cấu hình.