Skip to content
このページは AI の支援により作成・翻訳されました。誤りがあれば、改善にご協力ください。 GitHub で編集

オンボーディングウィザード

prx onboard コマンドは、プロバイダー選択、API キー入力、モデル選択、メモリバックエンドのセットアップを案内して、初期設定ファイルを作成します。PRX を初めて設定する際に推奨される方法です。

オンボーディングの動作

prx onboard を実行すると、ウィザードは以下のステップを実行します:

  1. LLM プロバイダーの選択 -- サポートされている 9 つのプロバイダー(Anthropic、OpenAI、Google Gemini、Ollama、OpenRouter など)から選択するよう案内します
  2. API キーの保存 -- プロバイダーの認証情報を設定ファイルに安全に書き込みます
  3. 利用可能なモデルの取得 -- プロバイダー API にクエリして、アクセス可能なモデルの一覧を表示します
  4. デフォルトモデルの設定 -- デフォルトで使用するモデルを選択できます
  5. メモリバックエンドの設定 -- Markdown(ファイルベース)、SQLite、PostgreSQL から選択します
  6. 設定ファイルの書き込み -- 設定を反映した ~/.config/openprx/openprx.toml を作成します

オンボーディング後、prx daemon または prx chat で PRX を実行する準備が整います。

対話型モード

デフォルトのオンボーディングは必要最小限の質問のみを行うクイックセットアップです。すべての設定セクションを案内する完全な対話型ウィザードを実行するには、--interactive フラグを使用します:

bash
prx onboard --interactive

対話型ウィザードには以下の追加設定が含まれます:

  • ゲートウェイのホストとポート設定
  • チャネルの事前設定(Telegram、Discord など)
  • セキュリティと自律性レベル
  • ワークスペースディレクトリ
  • 可観測性の設定

クイックセットアップ(デフォルト)

デフォルトの prx onboard は簡略化されたクイックセットアップを実行します:

bash
prx onboard

プロバイダー、API キー、モデルのみを質問します。その他の設定はすべてデフォルト値が使用されます。

フラグ付きクイックセットアップ

フラグを指定して対話型プロンプトを完全にスキップできます:

bash
prx onboard \
  --provider anthropic \
  --api-key sk-ant-api03-xxxxxxxxxxxx \
  --model claude-sonnet-4-20250514

利用可能なフラグ:

フラグ説明
--providerLLM プロバイダー名anthropic, openai, ollama, openrouter
--api-keyプロバイダーの API キーまたは認証情報sk-ant-..., sk-...
--modelデフォルトモデルの識別子claude-sonnet-4-20250514, gpt-4o
--memoryメモリバックエンドmarkdown, sqlite, postgres
--interactive完全な対話型ウィザードを実行(値なし)
--channels-onlyチャネル修復ウィザードのみ再実行(値なし)

使用例

Anthropic Claude(デフォルト設定):

bash
prx onboard --provider anthropic --api-key "$ANTHROPIC_API_KEY"

ローカル Ollama(API キー不要):

bash
prx onboard --provider ollama --model llama3.2

OpenRouter で特定のモデルを指定:

bash
prx onboard --provider openrouter --api-key "$OPENROUTER_API_KEY" --model anthropic/claude-sonnet-4-20250514

OpenAI と SQLite メモリ:

bash
prx onboard --provider openai --api-key "$OPENAI_API_KEY" --model gpt-4o --memory sqlite

設定ファイル

オンボーディングウィザードは以下に設定を書き込みます:

~/.config/openprx/openprx.toml

Linux では XDG Base Directory 仕様に従います。macOS では XDG_CONFIG_HOME が設定されていない限り ~/Library/Application Support/openprx/openprx.toml を使用します。

生成される設定ファイルの例

prx onboard --provider anthropic --model claude-sonnet-4-20250514 を実行した後、生成される設定は以下のようになります:

toml
# OpenPRX Configuration
# Generated by: prx onboard

# ── Provider ──────────────────────────────────────────────
default_provider = "anthropic"
default_model = "claude-sonnet-4-20250514"
default_temperature = 0.7
api_key = "sk-ant-api03-xxxxxxxxxxxx"

# ── Workspace ─────────────────────────────────────────────
workspace_dir = "~/.local/share/openprx"

# ── Memory ────────────────────────────────────────────────
[memory]
backend = "markdown"
# path defaults to workspace_dir/memory

# ── Gateway ───────────────────────────────────────────────
[gateway]
host = "127.0.0.1"
port = 3120

# ── Channels ──────────────────────────────────────────────
[channels]
cli = true

# ── Security ──────────────────────────────────────────────
[security]
autonomy = "supervised"

このファイルはいつでも編集できます。PRX はホットリロードをサポートしています -- ほとんどの変更はデーモンを再起動することなく反映されます。

設定セクション

設定ファイルは以下のトップレベルセクションをサポートしています:

セクション目的
default_providerデフォルトで使用する LLM プロバイダー
default_modelデフォルトで使用するモデル
api_keyプロバイダーの API 認証情報
[memory]メモリバックエンドとストレージ設定
[gateway]HTTP/WebSocket ゲートウェイ設定
[channels]メッセージングチャネル設定
[channels.telegram]Telegram ボット設定
[channels.discord]Discord ボット設定
[security]自律性レベル、サンドボックス、ポリシー
[router]LLM ルーティング戦略
[self_system]自己進化パイプライン設定
[observability]メトリクス、トレーシング、ロギング
[cron]スケジュールタスク設定
[plugins]WASM プラグインのパスと設定

利用可能なすべてのオプションについては、完全な設定リファレンスを参照してください。

オンボーディング後の検証

オンボーディング後、診断コマンドを実行してすべてが正しく設定されているか確認します:

bash
prx doctor

doctor コマンドは以下をチェックします:

  • 設定ファイル -- TOML 構文と必須フィールドの検証
  • プロバイダー接続 -- プロバイダーへのクエリで API キーをテスト
  • モデルの利用可能性 -- 選択したモデルがアクセス可能であることを確認
  • メモリバックエンド -- ストレージバックエンドが書き込み可能であることを検証
  • システム依存関係 -- オプションのツール(git、docker など)を確認
  • ネットワーク -- 設定されたサービスへの接続をテスト

出力例:

PRX Doctor

  Config file .............. OK  (~/.config/openprx/openprx.toml)
  Provider (anthropic) ..... OK  (authenticated)
  Model .................... OK  (claude-sonnet-4-20250514)
  Memory (markdown) ........ OK  (writable)
  Gateway port (3120) ...... OK  (available)
  Git ...................... OK  (2.43.0)
  Docker ................... WARN (not installed -- sandbox features limited)

All critical checks passed.

doctor サブコマンド

doctor にはターゲットを絞った診断のためのサブコマンドもあります:

bash
# すべてのプロバイダーのモデルカタログを調査
prx doctor models

# 特定のプロバイダーのモデルを調査
prx doctor models --provider anthropic

チャネル修復ウィザード

既にオンボーディングを完了しており、チャネル設定の追加や修正を行いたい場合は、--channels-only フラグを使用します:

bash
prx onboard --channels-only

これによりプロバイダーとモデルの設定をスキップし、直接チャネル設定に進みます。

オンボーディングの再実行

prx onboard はいつでも再実行できます。ウィザードは既存の設定を検出し、ゼロからの上書きではなく更新を提案します。既存のチャネル設定、メモリデータ、カスタム設定は保持されます。

次のステップ

Released under the Apache-2.0 License.