Chuyển đến nội dung chính

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

Mục đích: các bề mặt onboarding + cấu hình dùng chung trên CLI, ứng dụng macOS và Web UI.

Thành phần

  • Công cụ wizard (phiên dùng chung + lời nhắc + trạng thái onboarding).
  • Onboarding trên CLI sử dụng cùng luồng wizard như các client UI.
  • RPC của Gateway cung cấp các endpoint wizard + lược đồ cấu hình.
  • Onboarding trên macOS sử dụng mô hình bước của wizard.
  • Web UI hiển thị biểu mẫu cấu hình từ JSON Schema + gợi ý UI.

RPC của Gateway

  • wizard.start params: { mode?: "local"|"remote", workspace?: string }
  • Tham số wizard.next: { sessionId, answer?: { stepId, value? }` }
  • wizard.cancel params: { sessionId }
  • wizard.status params: { sessionId }
  • config.schema params: {}
Phản hồi (hình dạng)
  • Wizard: { sessionId, done, step?, status?, error? Các log gateway gần đây cho thấy lỗi cron.add lặp lại với tham số không hợp lệ (thiếu sessionTarget, wakeMode, payload, và schedule bị sai định dạng).
  • Lược đồ cấu hình: { schema, uiHints, version, generatedAt }

Gợi ý UI

  • uiHints được khóa theo đường dẫn; metadata tùy chọn (label/help/group/order/advanced/sensitive/placeholder).
  • Các trường nhạy cảm hiển thị dưới dạng input mật khẩu; không có lớp che/redaction.
  • Các node lược đồ không được hỗ trợ sẽ quay về trình chỉnh sửa JSON thô.

Ghi chú

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