オンボーディング+設定プロトコル

目的: CLI、macOSアプリ、Web UI全体で共有されるオンボーディングと設定のインターフェース。

構成要素

  • ウィザードエンジン(共有セッション+プロンプト+オンボーディング状態)。
  • CLIオンボーディングはUIクライアントと同じウィザードフローを使用。
  • Gateway RPCがウィザード+設定スキーマのエンドポイントを公開。
  • macOSオンボーディングはウィザードステップモデルを使用。
  • Web UIはJSON Schema+UIヒントから設定フォームをレンダリング。

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, uiHints, version, generatedAt }
  • 設定スキーマルックアップ: { path, schema, hint?, hintPath?, children[] }

UIヒント

  • uiHintsはパスをキーとするオプションのメタデータ(label/help/group/order/advanced/sensitive/placeholder)。
  • センシティブなフィールドはパスワード入力として表示。リダクション層は不要。
  • サポートされていないスキーマノードはローJSON エディターにフォールバック。

メモ

  • このドキュメントは、オンボーディング/設定のプロトコルリファクタリングを一元管理するためのもの。