初めてセットアップする場合は、はじめにから始めてください。
ウィザードの詳細については、オンボーディングウィザードを参照してください。
概要 (TL;DR)
- カスタマイズはリポジトリの外部に置きます:
~/.openclaw/workspace(ワークスペース) +~/.openclaw/openclaw.json(設定)。 - 安定したワークフロー: macOS アプリをインストールし、バンドルされた Gateway を実行させます。
- 最先端 (Bleeding edge) のワークフロー:
pnpm gateway:watchを介して自分で Gateway を実行し、macOS アプリをローカルモードでアタッチさせます。
前提条件 (ソースから)
- Node
>=22 pnpm- Docker (オプション。コンテナ化されたセットアップ/e2e のみ — Docker を参照してください)
カスタマイズ戦略 (アップデートで壊れないようにする)
「100% 自分向けにカスタマイズされたもの」かつ簡単なアップデートが必要な場合は、カスタマイズを以下に保持します:- 設定:
~/.openclaw/openclaw.json(JSON / JSON5 風) - ワークスペース:
~/.openclaw/workspace(スキル、プロンプト、記憶。プライベートな git リポジトリにしてください)
pnpm openclaw setup 経由で実行してください。
このリポジトリから Gateway を実行する
pnpm build の後、パッケージ化された CLI を直接実行できます:
安定したワークフロー (macOS アプリ優先)
- OpenClaw.app (メニューバー) をインストールして起動します。
- オンボーディング / 権限チェックリスト (TCC プロンプト) を完了します。
- Gateway が Local になっており、実行されていることを確認します (アプリが管理します)。
- サーフェスをリンクします (例:WhatsApp):
- サニティチェック:
openclaw setupを実行し、次にopenclaw channels loginを実行して、手動で Gateway を起動します (openclaw gateway)。
最先端のワークフロー (ターミナルでの Gateway)
目標:TypeScript の Gateway で作業し、ホットリロードを取得し、macOS アプリの UI をアタッチしたままにする。0) (オプション) macOS アプリもソースから実行する
macOS アプリも最先端の状態にしたい場合:1) 開発用 Gateway を起動する
gateway:watch はゲートウェイをウォッチモードで実行し、TypeScript の変更時にリロードします。
2) macOS アプリを実行中の Gateway に向ける
OpenClaw.app で:- 接続モード (Connection Mode): Local アプリは、設定されたポートで実行中のゲートウェイにアタッチします。
3) 確認
- アプリ内の Gateway ステータスが “Using existing gateway …” になっているはずです
- または CLI 経由:
よくある落とし穴
- 間違ったポート: Gateway WS のデフォルトは
ws://127.0.0.1:18789です。アプリと CLI を同じポートに保ってください。 - 状態が保存される場所:
- 資格情報:
~/.openclaw/credentials/ - セッション:
~/.openclaw/agents/<agentId>/sessions/ - ログ:
/tmp/openclaw/
- 資格情報:
資格情報ストレージマップ
認証のデバッグやバックアップ対象を決定する際にこれを使用してください:- WhatsApp:
~/.openclaw/credentials/whatsapp/<accountId>/creds.json - Telegram ボットトークン: config/env または
channels.telegram.tokenFile - Discord ボットトークン: config/env または SecretRef (env/file/exec プロバイダー)
- Slack トークン: config/env (
channels.slack.*) - ペアリング許可リスト:
~/.openclaw/credentials/<channel>-allowFrom.json(デフォルトアカウント)~/.openclaw/credentials/<channel>-<accountId>-allowFrom.json(非デフォルトアカウント)
- モデル認証プロファイル:
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - ファイルバックアップされたシークレットペイロード (オプション):
~/.openclaw/secrets.json - レガシー OAuth インポート:
~/.openclaw/credentials/oauth.json詳細: セキュリティ。
アップデート (セットアップを壊さずに)
~/.openclaw/workspaceと~/.openclaw/は「あなたのもの」として保持してください。個人のプロンプトや設定をopenclawリポジトリに入れないでください。- ソースのアップデート:
git pull+pnpm install(ロックファイルが変更された場合) + 引き続きpnpm gateway:watchを使用します。
Linux (systemd ユーザーサービス)
Linux インストールでは、systemd のユーザーサービスを使用します。デフォルトでは、systemd はログアウトやアイドル状態になるとユーザーサービスを停止し、Gateway を終了させます。オンボーディングでは、リンガリング (lingering) の有効化を試みます (sudo のプロンプトが表示される場合があります)。それでもオフの場合は、次を実行してください:関連ドキュメント
- Gateway ランブック (フラグ、監視、ポート)
- Gateway の構成 (設定スキーマ + 例)
- Discord および Telegram (返信タグ + replyToMode 設定)
- OpenClaw アシスタントのセットアップ
- macOS アプリ (ゲートウェイのライフサイクル)