CLI オンボーディングリファレンス

このページは mayros onboard の完全なリファレンスです。短いガイドについては、オンボーディングウィザード (CLI) をご覧ください。

ウィザードの動作

ローカルモード（デフォルト）では以下の手順を案内します：

モデルと認証のセットアップ（OpenAI Code サブスクリプション OAuth、Anthropic API キーまたはセットアップトークン、MiniMax、GLM、Moonshot、AI Gateway オプション）
ワークスペースの場所とブートストラップファイル
ゲートウェイ設定（ポート、バインド、認証、Tailscale）
チャンネルとプロバイダー（Telegram、WhatsApp、Discord、Google Chat、Mattermost プラグイン、Signal）
デーモンのインストール（LaunchAgent または systemd ユーザーユニット）
ヘルスチェック
スキルのセットアップ

リモートモードは、このマシンを他の場所にあるゲートウェイに接続するよう設定します。リモートホスト上のインストールや変更は行いません。

ローカルフローの詳細

既存設定の検出

~/.mayros/mayros.json が存在する場合、維持、変更、リセットのいずれかを選択します。
ウィザードを再実行しても、明示的にリセットを選択（または --reset を渡す）しない限り、何も消去されません。
設定が無効またはレガシーキーを含む場合、ウィザードは停止し、続行前に mayros doctor の実行を求めます。
リセットは trash を使用し、スコープを選択できます：
- 設定のみ
- 設定 + 資格情報 + セッション
- 完全リセット（ワークスペースも削除）

モデルと認証

オプションの完全なマトリックスは認証とモデルオプションにあります。

ワークスペース

デフォルトは ~/.mayros/workspace（変更可能）。
初回実行ブートストラップ儀式に必要なワークスペースファイルを初期配置します。
ワークスペースのレイアウト: エージェントワークスペース。

ゲートウェイ

ポート、バインド、認証モード、Tailscale 公開について入力を求めます。
推奨: ループバックでもトークン認証を有効にしておくことで、ローカル WS クライアントに認証を要求できます。
すべてのローカルプロセスを完全に信頼する場合のみ、認証を無効にしてください。
非ループバックバインドでは認証が必須です。

チャンネル

WhatsApp: オプションの QR ログイン
Telegram: ボットトークン
Discord: ボットトークン
Google Chat: サービスアカウント JSON + Webhook オーディエンス
Mattermost プラグイン: ボットトークン + ベース URL
Signal: オプションの signal-cli インストール + アカウント設定
BlueBubbles: iMessage に推奨; サーバー URL + パスワード + Webhook
iMessage: レガシー imsg CLI パス + DB アクセス
DM セキュリティ: デフォルトはペアリングです。最初の DM でコードが送信されます。mayros pairing approve <channel> <code> で承認するか、許可リストを使用してください。

デーモンのインストール

macOS: LaunchAgent
- ログインしたユーザーセッションが必要です。ヘッドレス環境では、カスタム LaunchDaemon を使用してください（同梱されていません）。
Linux および Windows（WSL2 経由）: systemd ユーザーユニット
- ウィザードは loginctl enable-linger <user> を試みて、ログアウト後もゲートウェイを稼働させます。
- sudo を求めることがあります（/var/lib/systemd/linger に書き込み）。まず sudo なしで試みます。
ランタイムの選択: Node（推奨; WhatsApp と Telegram に必須）。Bun は推奨されません。

ヘルスチェック

ゲートウェイを起動し（必要に応じて）、mayros health を実行します。
mayros status --deep はステータス出力にゲートウェイヘルスプローブを追加します。

スキル

利用可能なスキルを読み取り、要件を確認します。
ノードマネージャーを選択できます: npm または pnpm（bun は推奨されません）。
オプションの依存関係をインストールします（macOS では一部 Homebrew を使用）。

完了

サマリーと次のステップ（iOS、Android、macOS アプリのオプションを含む）。

GUI が検出されない場合、ウィザードはブラウザを開く代わりに Control UI 用の SSH ポートフォワード手順を表示します。 Control UI のアセットが見つからない場合、ウィザードはビルドを試みます。フォールバックは pnpm ui:build です（UI の依存関係を自動インストール）。

リモートモードの詳細

リモートモードは、このマシンを他の場所にあるゲートウェイに接続するよう設定します。

リモートモードはリモートホスト上のインストールや変更を行いません。

設定する内容：

リモートゲートウェイ URL（ws://...）
リモートゲートウェイの認証が必要な場合のトークン（推奨）

ゲートウェイがループバック専用の場合、SSH トンネリングまたは Tailnet を使用してください。
ディスカバリーのヒント：
- macOS: Bonjour (dns-sd)
- Linux: Avahi (avahi-browse)

認証とモデルオプション

モデルの動作：

検出されたオプションからデフォルトモデルを選択するか、プロバイダーとモデルを手動で入力します。
ウィザードはモデルチェックを実行し、設定されたモデルが不明または認証が不足している場合に警告します。

資格情報とプロファイルのパス：

OAuth 資格情報: ~/.mayros/credentials/oauth.json
認証プロファイル（API キー + OAuth）: ~/.mayros/agents/<agentId>/agent/auth-profiles.json

ヘッドレスおよびサーバーのヒント: ブラウザを持つマシンで OAuth を完了してから、~/.mayros/credentials/oauth.json（または $MAYROS_STATE_DIR/credentials/oauth.json）をゲートウェイホストにコピーしてください。

出力と内部動作

~/.mayros/mayros.json の典型的なフィールド：

agents.defaults.workspace
agents.defaults.model / models.providers（Minimax を選択した場合）
gateway.*（モード、バインド、認証、Tailscale）
channels.telegram.botToken、channels.discord.token、channels.signal.*、channels.imessage.*
チャンネル許可リスト（Slack、Discord、Matrix、Microsoft Teams）プロンプトでオプトインした場合（名前は可能な限り ID に解決されます）
skills.install.nodeManager
wizard.lastRunAt
wizard.lastRunVersion
wizard.lastRunCommit
wizard.lastRunCommand
wizard.lastRunMode

mayros agents add は agents.list[] とオプションの bindings を書き込みます。

WhatsApp の資格情報は ~/.mayros/credentials/whatsapp/<accountId>/ 配下に保存されます。セッションは ~/.mayros/agents/<agentId>/sessions/ 配下に保存されます。

一部のチャンネルはプラグインとして提供されます。オンボーディング中に選択した場合、ウィザードはチャンネル設定の前にプラグインのインストール（npm またはローカルパス）を求めます。

ゲートウェイウィザード RPC：

wizard.start
wizard.next
wizard.cancel
wizard.status

クライアント（macOS アプリと Control UI）は、オンボーディングロジックを再実装することなくステップをレンダリングできます。

Signal セットアップの動作：

適切なリリースアセットをダウンロード
~/.mayros/tools/signal-cli/<version>/ 配下に保存
設定に channels.signal.cliPath を書き込み
JVM ビルドには Java 21 が必要
利用可能な場合はネイティブビルドを使用
Windows は WSL2 を使用し、WSL 内の Linux signal-cli フローに従う