clawdbot/docs/onboarding-config-protocol.md

Onboarding + Config Protocol

Purpose: shared onboarding + config surfaces across CLI, macOS app, and Web UI.

Components

• Wizard engine: src/wizard (session + prompts + onboarding state).
• CLI: src/commands/onboard-*.ts uses the wizard with the CLI prompter.
• Gateway RPC: wizard + config schema endpoints serve UI clients.
• macOS: SwiftUI onboarding uses the wizard step model.
• Web UI: config form renders from JSON Schema + 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 keyed by path; optional metadata (label/help/group/order/advanced/sensitive/placeholder).
• Sensitive fields render as password inputs; no redaction layer.
• Unsupported schema nodes fall back to the raw JSON editor.

Notes

• This doc is the single place to track protocol refactors for onboarding/config.