Claw-Empire

Claw-Empire

CEOデスクからAIエージェント帝国を指揮しよう
CLI、OAuth、API連携プロバイダー(Claude Code、Codex CLI、Gemini CLI、OpenCode、Kimi Code、GitHub Copilot、Antigravity など)を自律エージェントの仮想企業として統合運用するローカルファーストAIエージェントオフィスシミュレーター

Releases CI Node.js 22+ License Platform AI Agents

クイックスタート · AIインストール · リリースノート · OpenClaw連携 · 直接メッセンジャー · $ コマンド · 機能一覧 · スクリーンショット · 技術スタック · プロバイダー · Dockerデプロイ · セキュリティ

English | 한국어 | 日本語 | 中文

Office View

--- ## Claw-Empireとは? Claw-Empireは **CLI**、**OAuth**、**直接APIキー** で接続されたAIコーディングアシスタントを、完全にシミュレートされた**仮想ソフトウェア会社**へと変革します。あなたがCEOです。AIエージェントたちが社員として働きます。部署をまたいで協力し、会議を開き、タスクを完遂し、レベルアップしていく様子を、魅力的なピクセルアートのオフィスインターフェースを通じてリアルタイムに観察できます。 ### なぜClaw-Empireなのか? - **一つのインターフェースで複数のAIエージェントを管理** — CLI/OAuth/API接続エージェントを単一のダッシュボードから一元管理 - **ローカルファースト&プライバシー保護** — すべてのデータはローカルに保存。SQLiteデータベースを使用し、クラウド依存ゼロ - **直感的なビジュアル体験** — ピクセルアートのオフィスビューがAIオーケストレーションを楽しく、わかりやすく表現 - **真の自律コラボレーション** — エージェントは独立したgit worktreeで作業し、会議に参加して成果物を生み出す --- ## AIでインストール > **以下をAIコーディングエージェント(Claude Code、Codex、Gemini CLI等)に貼り付けるだけです:** > > ``` > Install Claw-Empire following the guide at: > https://github.com/GreenSheep01201/claw-empire > ``` > > AIがこのREADMEを読んで自動的にすべてを処理します。 --- ## 最新リリース (v2.0.4) - **Dockerデプロイが正式な運用パスとして追加されました** - プロダクション向け `Dockerfile`、`docker-compose.yml`、`.dockerignore`、コンテナ環境向けランタイムパス整理が含まれます。 - **中断後に `working` のまま残ったエージェントを自動復旧します** - lifecycle の起動時/定期スイープが、生きた `in_progress` タスクを持たない `working` エージェントを `idle` に戻します。 - **Settings > API で公式 direct API プリセットが使えるようになりました** - OpenCode Go と Bailian Coding Plan のプリセットが Base URL 固定、fallback モデル初期化、明示的な refresh/retry 動線を提供します。 - **Kimi Code が end-to-end でサポートされました** - CLI 実行、プロバイダー表示、skills learn/unlearn、prompt skills、video-preprod bootstrap、既存 schema/runtime の provider チェックまで接続されています。 - **API モデル割り当ては development を起点に、初期セットアップ済みの office pack まで広がります** - `development` を既定の基準線として保ちつつ、すでに hydrate 済みの office pack も割り当て対象に含まれます。 - **ローカル E2E 検証がより安全でクリーンになりました** - `pnpm run test:e2e` は Playwright 実行の前後で隔離ランタイムを初期化し、既存の `8810` サーバー再利用も明示的に opt-in した場合のみ有効です。 - 詳細: [`docs/releases/v2.0.4.md`](docs/releases/v2.0.4.md) - APIドキュメント: [`docs/api.md`](docs/api.md), [`docs/openapi.json`](docs/openapi.json) - セキュリティポリシー: [`SECURITY.md`](SECURITY.md) ## オフィスパックプロファイル (v2.0.1) 各オフィスパックは、協業構造・命名シード・ワークフロー特性が異なるプロファイルとして動作します。 | パック | 中核フォーカス | 代表的な組織構成 | | ----------------------------- | ------------------------------------------------------- | -------------------------------------------------------------- | | `development` (`DEV`) | 後方互換を維持する標準開発ベースライン | 企画 / 開発 / デザイン / QA-QC / DevSecOps / 運用 | | `report` (`RPT`) | 構造化レポートと文書成果物の作成 | 編集企画室、リサーチエンジン、ドキュメントデザイン、レビュー班 | | `web_research_report` (`WEB`) | 情報源収集と引用根拠検証を重視した調査 | 調査戦略室、クロール班、ファクトチェック | | `novel` (`NOV`) | 世界観・物語・文体トーンの一貫性重視 | 世界観室、物語エンジン、キャラアート、トーン検証 | | `video_preprod` (`VID`) | コンセプト/台本/ショットリスト/編集ノートのプリプロ品質 | プリプロ班、シーン設計、アート撮影、カット検証 | | `roleplay` (`RPG`) | キャラになりきる会話没入と設定一貫性 | キャラ企画室、会話エンジン、演出アート、キャラ検証 | ## スクリーンショット
**ダッシュボード** — リアルタイムKPIメトリクス、エージェントランキング、各部署のステータスを一目で把握 Dashboard **カンバンボード** — 部署・エージェントフィルター付きのドラッグ&ドロップによるタスク管理 Kanban Board
**スキルライブラリ** — カテゴリ別に整理された600以上のエージェントスキルを閲覧・割り当て Skills Library **マルチプロバイダーCLI** — Claude Code、Codex、Gemini CLI、OpenCode、Kimi Code をモデル選択付きで設定 CLI Tools Settings
**OAuth連携** — 暗号化トークンストレージによる安全なGitHub・Google OAuth OAuth Settings **議事録** — AIが生成する会議サマリーと複数ラウンドのレビュー承認フロー Meeting Minutes
**メッセンジャー連携** — Telegram、WhatsApp、Discord、Google Chat、Slack、Signal、iMessage セッションを設定して `$` CEOディレクティブを送信 Messenger Integration **設定** — 会社名、CEO名、デフォルトプロバイダー設定(CLI/OAuth/API)、言語などの環境設定 Settings
**詳細レポート** — リクエスト完了時のレポートポップアップ、履歴、詳細表示のサンプル Detailed Report **PPT生成例** — レポート依頼から生成されたPPT出力のサンプル

PPT Generation Example 0 PPT Generation Example 1

### 映像出力サンプル イントロ映像の出力サンプル:

- ファイルリンク: [`Sample_Img/claw-empire-intro.mp4`](Sample_Img/claw-empire-intro.mp4) ### PPT サンプルソース レポートからPPTを生成する機能を確認・拡張するためのサンプルを参照できます。 利用手順: **チャット画面 > Report Request ボタン** を押して依頼内容を入力してください。 - フォルダ: [`docs/reports/Sample_Slides`](docs/reports/Sample_Slides) - サンプルデッキ(`.pptx`): [`docs/reports/PPT_Sample.pptx`](docs/reports/PPT_Sample.pptx) - HTMLスライド: [`slide-01.html`](docs/reports/Sample_Slides/slide-01.html), [`slide-02.html`](docs/reports/Sample_Slides/slide-02.html), [`slide-03.html`](docs/reports/Sample_Slides/slide-03.html), [`slide-04.html`](docs/reports/Sample_Slides/slide-04.html), [`slide-05.html`](docs/reports/Sample_Slides/slide-05.html), [`slide-06.html`](docs/reports/Sample_Slides/slide-06.html), [`slide-07.html`](docs/reports/Sample_Slides/slide-07.html), [`slide-08.html`](docs/reports/Sample_Slides/slide-08.html), [`slide-09.html`](docs/reports/Sample_Slides/slide-09.html) - ビルドスクリプト: [`build-pptx.mjs`](docs/reports/Sample_Slides/build-pptx.mjs), [`build-pptx.cjs`](docs/reports/Sample_Slides/build-pptx.cjs), [`html2pptx.cjs`](docs/reports/Sample_Slides/html2pptx.cjs) --- ## 機能一覧 | 機能 | 説明 | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **ピクセルアートオフィス** | 6つの部署でエージェントが歩き回り、作業し、会議に参加するアニメーション付きオフィスビュー | | **ワークフローパックプロファイル** | `development` / `report` / `web_research_report` / `novel` / `video_preprod` / `roleplay` の6種で、ルーティングスキーマ・QAルール・出力テンプレートを切り替え可能 | | **オフィスパックプロファイル** | パック単位で部署トポロジー、命名/テーマシード、社員・部署データを分離運用(開発パックは既存DB基準線を維持) | | **カンバンタスクボード** | 受信箱、計画中、協議中、進行中、レビュー中、完了 — ドラッグ&ドロップ対応の完全なタスクライフサイクル管理 | | **CEOチャット&ディレクティブ** | チームリーダーへの直接コミュニケーション;`$` ディレクティブで会議選択と作業パス/コンテキスト(`project_path`、`project_context`)を指定可能 | | **マルチプロバイダー対応** | Claude Code、Codex CLI、Gemini CLI、OpenCode、Kimi Code、Antigravity — すべて一つのダッシュボードから管理 | | **外部APIプロバイダー** | 設定 > APIタブからエージェントを外部LLM API(OpenAI、Anthropic、Google、Ollama、OpenRouter、Together、Groq、Cerebras、カスタム)に接続し、OpenCode Go / Bailian の公式プリセットも利用可能 | | **OAuth連携** | ローカルSQLiteへのAES暗号化トークンストレージによるGitHub・Google OAuth | | **リアルタイムWebSocket** | ライブステータス更新、アクティビティフィード、エージェント状態のリアルタイム同期 | | **アクティブエージェント制御** | 作業中エージェントのプロセス/活動/アイドル情報を可視化し、スタックしたタスクを強制停止 | | **タスクレポートシステム** | 完了ポップアップ、レポート履歴、チーム別詳細、企画リード統合アーカイブ | | **社員管理** | 社員の採用・編集・削除、多言語名、部署・役職・プロバイダー選択および性格設定に対応 | | **エージェントランキング&XP** | タスク完了でXPを獲得するエージェント;上位パフォーマーを追跡するランキングボード | | **スキルライブラリ** | Frontend、Backend、Design、AI、DevOps、Securityなど600以上のカテゴリ別スキル、カスタムスキルアップロード対応 | | **ミーティングシステム** | 予定・臨時ミーティング対応;AIによる議事録自動生成と複数ラウンドレビュー機能 | | **Git Worktree分離** | 各エージェントは独立したgitブランチで作業し、CEO承認後にのみマージ | | **多言語UI** | 英語、韓国語、日本語、中国語 — 自動検出または手動設定 | | **メッセンジャー連携** | Telegram、Discord、Slack等 — 内蔵の直接チャネルセッション経由で `$` CEOディレクティブ送信&更新受信(OpenClawは任意) | | **PowerPointエクスポート** | 議事録やレポートからプレゼンテーションスライドを自動生成 | | **通信QAスクリプト** | `test:comm:*` スクリプトでCLI/OAuth/API疎通を再試行・証跡ログ付きで検証 | | **インアプリ更新通知** | GitHub 最新リリースを確認し、新バージョンがある場合にOS別 `git pull` 手順とリリースノートリンクを上部バナー表示 | | **部署管理** | 企画、開発、デザイン、QA/QC、DevSecOps、オペレーション — 専用管理タブで矢印/ドラッグ&ドロップ並び順編集が可能 | | **社員手動割り当て** | プロジェクトに特定社員を指定すると、会議やタスク委任で指定社員のみを対象に運用 | | **スプライト登録安全装置** | 重複スプライト番号ファイルの上書きを `409 sprite_number_exists` レスポンスで防止 | | **カスタムスキルアップロード** | UIから `.md` スキルファイルをアップロードしてCLI代表にカスタムスキルを学習させる。黒板教室アニメーションと管理画面付き | --- ## 技術スタック | レイヤー | 技術 | | -------------------------- | --------------------------------------------------- | | **フロントエンド** | React 19 + Vite 7 + Tailwind CSS 4 + TypeScript 5.9 | | **ピクセルアートエンジン** | PixiJS 8 | | **バックエンド** | Express 5 + SQLite(設定不要の組み込みDB) | | **リアルタイム通信** | WebSocket (ws) | | **バリデーション** | Zod 4 | | **アイコン** | Lucide React | | **ルーティング** | React Router 7 | | **エクスポート** | PptxGenJS(PowerPoint生成) | ## AIインストールガイド > このセクションはAIコーディングエージェント向けです。各ステップで検証コマンドを実行してから次に進んでください。 ### ステップ0: 前提条件の確認 ```bash # Node.js 22+ node -v # pnpm(未導入ならcorepackを有効化) pnpm -v || corepack enable # git git --version ``` ### ステップ1: クローンしてワンクリックセットアップ ```bash git clone https://github.com/GreenSheep01201/claw-empire.git cd claw-empire git submodule update --init --recursive bash install.sh ``` Windows PowerShell: ```powershell git clone https://github.com/GreenSheep01201/claw-empire.git cd claw-empire git submodule update --init --recursive powershell -ExecutionPolicy Bypass -File .\install.ps1 ``` ### ステップ2: セットアップ結果の検証 macOS/Linux: ```bash # 必須ファイル確認 [ -f .env ] && [ -f scripts/setup.mjs ] && echo "setup files ok" # AGENTSオーケストレーションルール確認 grep -R "BEGIN claw-empire orchestration rules" ~/.openclaw/workspace/AGENTS.md AGENTS.md 2>/dev/null || true grep -R "INBOX_SECRET_DISCOVERY_V2" ~/.openclaw/workspace/AGENTS.md AGENTS.md 2>/dev/null || true # OpenClaw inbox 必須 .env 項目確認 grep -E '^(INBOX_WEBHOOK_SECRET|OPENCLAW_CONFIG)=' .env || true ``` Windows PowerShell: ```powershell if ((Test-Path .\.env) -and (Test-Path .\scripts\setup.mjs)) { "setup files ok" } $agentCandidates = @("$env:USERPROFILE\.openclaw\workspace\AGENTS.md", ".\AGENTS.md") $agentCandidates | ForEach-Object { if (Test-Path $_) { Select-String -Path $_ -Pattern "BEGIN claw-empire orchestration rules" } } $agentCandidates | ForEach-Object { if (Test-Path $_) { Select-String -Path $_ -Pattern "INBOX_SECRET_DISCOVERY_V2" } } # OpenClaw inbox 必須 .env 項目確認 Get-Content .\.env | Select-String -Pattern '^(INBOX_WEBHOOK_SECRET|OPENCLAW_CONFIG)=' ``` ### ステップ3: 起動とヘルスチェック ```bash pnpm dev:local ``` 別ターミナルで: ```bash curl -s http://127.0.0.1:8790/healthz ``` 期待値: `{"ok":true,...}` メッセンジャーチャネルは設定 UI で登録され、SQLite(`settings.messengerChannels`)に保存されます。.env ベースのメッセンジャートークン/チャネル変数は現在使用しません。 ### ステップ4: メッセンジャー + inbox(任意)検証 ```bash curl -s http://127.0.0.1:8790/api/messenger/sessions ``` 設定に保存されたメッセンジャーセッション一覧が返ります。 ```bash curl -X POST http://127.0.0.1:8790/api/inbox \ -H "content-type: application/json" \ -H "x-inbox-secret: $INBOX_WEBHOOK_SECRET" \ -d '{"source":"telegram","author":"ceo","text":"$README v1.1.6 inbox 検証","skipPlannedMeeting":true}' ``` 期待値: - サーバーに `INBOX_WEBHOOK_SECRET` が設定され、`x-inbox-secret` が一致する場合は `200` - ヘッダー欠落/不一致の場合は `401` - サーバー側 `INBOX_WEBHOOK_SECRET` 未設定の場合は `503` ### ステップ5: OpenClawなしでメッセンジャーを直接接続 OpenClawを使わなくても、Claw-Empire単体でメッセンジャーチャネルを直接運用できます。 1. `Settings > チャネルメッセージ` を開きます。 2. `新しいチャットを追加` をクリックします。 3. メッセンジャーを選択します(`telegram`, `whatsapp`, `discord`, `googlechat`, `slack`, `signal`, `imessage`)。 4. セッション情報を入力します。 - `名前`(セッションラベル) - メッセンジャートークン/認証情報 - `Channel/Chat ID`(送信先) - 会話させる `Agent` マッピング 5. `確認` で即時保存されます(別の全体保存は不要)。 6. セッションを有効化してテストします。 - 通常メッセージ -> 担当Agentとの直接会話 - `$ ...` -> ディレクティブフロー 補足: - メッセンジャーセッションは SQLite(`settings.messengerChannels`)に保存されます。 - メッセンジャートークンは保存時に AES-256-GCM で暗号化され、`OAUTH_ENCRYPTION_SECRET`(未設定時は `SESSION_SECRET`)を使用します。復号は送受信の実行時のみ行われます。 - `.env` のメッセンジャー変数(`TELEGRAM_BOT_TOKEN`, `DISCORD_BOT_TOKEN`, `SLACK_BOT_TOKEN` など)は使用しません。 - `/api/inbox` + `INBOX_WEBHOOK_SECRET` は webhook/inbox 連携(OpenClawブリッジ含む)でのみ必要です。 --- ## クイックスタート ## Dockerデプロイ(クイック) このリポジトリは本番運用向けの Docker 既定設定を同梱しています。 - **非rootユーザー**(`app`, uid/gid `10001`)で実行 - 必須ツール(`git` / `bash` / `openssh-client`)を同梱 - 標準ファイル名 `docker-compose.yml` + `Dockerfile` を使用 - 実行データは `./data` に永続化(gitignore 済み) ### 1) 環境ファイル準備 ```bash cp .env.example .env.docker ``` 機密値は `.env.docker.private` に保存(ローカルのみ): ```bash cat > .env.docker.private <<'EOF' # Claude Code 互換エンドポイント ANTHROPIC_BASE_URL=https://api.minimaxi.com/anthropic ANTHROPIC_API_KEY=YOUR_ANTHROPIC_API_KEY EOF chmod 600 .env.docker.private ``` > `.env.docker*` は `.env.*` ルールで git 管理対象外です。 ### 2) 起動 ```bash docker compose up -d --build ``` ### 3) 確認 ```bash docker ps --filter name=claw-empire docker logs -f claw-empire ``` アクセス: `http://127.0.0.1:8790` ### 任意: GHCR へイメージ公開 ```bash # packages write 権限付き GitHub Token が必要 echo "" | docker login ghcr.io -u --password-stdin docker tag claw-empire-claw-empire:latest ghcr.io//claw-empire:latest docker push ghcr.io//claw-empire:latest ``` ### 前提条件 | ツール | バージョン | インストール | | ----------- | ---------- | ------------------------------------ | | **Node.js** | >= 22 | [nodejs.org](https://nodejs.org/) | | **pnpm** | 最新版 | `corepack enable`(Node.js組み込み) | | **Git** | 任意 | [git-scm.com](https://git-scm.com/) | ### ワンクリックセットアップ(推奨) | プラットフォーム | コマンド | | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | **macOS / Linux** | `git clone https://github.com/GreenSheep01201/claw-empire.git && cd claw-empire && bash install.sh` | | **Windows (PowerShell)** | `git clone https://github.com/GreenSheep01201/claw-empire.git; cd claw-empire; powershell -ExecutionPolicy Bypass -File .\install.ps1` | 既にクローン済みの場合: | プラットフォーム | コマンド | | ------------------------ | ---------------------------------------------------------------------------------------------------------------- | | **macOS / Linux** | `git submodule update --init --recursive && bash scripts/openclaw-setup.sh` | | **Windows (PowerShell)** | `git submodule update --init --recursive; powershell -ExecutionPolicy Bypass -File .\scripts\openclaw-setup.ps1` | ### OpenClaw `.env` 必須設定(`/api/inbox` 利用時) チャットWebhook連携の前に、`.env` に次の2項目を設定してください。 - `INBOX_WEBHOOK_SECRET=<十分に長いランダムシークレット>` - `OPENCLAW_CONFIG=`(引用符なし推奨) `scripts/openclaw-setup.sh` / `scripts/openclaw-setup.ps1` は `INBOX_WEBHOOK_SECRET` が未設定なら自動生成します。 初期インストール(`bash install.sh` / `install.ps1`)でも同じセットアップスクリプトを通るため、初回から自動適用されます。 既存クローンで `git pull` のみ実施した場合も、`pnpm dev*` / `pnpm start*` 初回実行時に必要条件で1回自動補正し、以後の再実行防止として `CLAW_MIGRATION_V1_0_5_DONE=1` を保存します。 `/api/inbox` はサーバー側 `INBOX_WEBHOOK_SECRET` と `x-inbox-secret` ヘッダーの完全一致が必要です。 - ヘッダー欠落/不一致 -> `401` - サーバー設定欠落(`INBOX_WEBHOOK_SECRET`) -> `503` ### 手動セットアップ(代替)
macOS / Linux ```bash # 1. リポジトリをクローン git clone https://github.com/GreenSheep01201/claw-empire.git cd claw-empire # 2. corepackでpnpmを有効化 corepack enable # 3. 依存関係をインストール pnpm install # 4. ローカル環境ファイルを作成 cp .env.example .env # 5. ランダムな暗号化シークレットを生成 node -e " const fs = require('fs'); const crypto = require('crypto'); const p = '.env'; const content = fs.readFileSync(p, 'utf8'); fs.writeFileSync(p, content.replace('__CHANGE_ME__', crypto.randomBytes(32).toString('hex'))); " # 6. AGENTS.mdオーケストレーション規則をセットアップ(AIエージェントにClaw-Empireプロジェクトマネージャーの役割を付与) pnpm setup -- --port 8790 # 7. 開発サーバーを起動 pnpm dev:local ```
Windows (PowerShell) ```powershell # 1. リポジトリをクローン git clone https://github.com/GreenSheep01201/claw-empire.git cd claw-empire # 2. corepackでpnpmを有効化 corepack enable # 3. 依存関係をインストール pnpm install # 4. ローカル環境ファイルを作成 Copy-Item .env.example .env # 5. ランダムな暗号化シークレットを生成 node -e "const fs=require('fs');const crypto=require('crypto');const p='.env';const c=fs.readFileSync(p,'utf8');fs.writeFileSync(p,c.replace('__CHANGE_ME__',crypto.randomBytes(32).toString('hex')))" # 6. AGENTS.mdオーケストレーション規則をセットアップ(AIエージェントにClaw-Empireプロジェクトマネージャーの役割を付与) pnpm setup -- --port 8790 # 7. 開発サーバーを起動 pnpm dev:local ```
### AGENTS.md セットアップ `pnpm setup` コマンドはAIエージェントの `AGENTS.md` ファイルに**CEOディレクティブオーケストレーション規則**を注入します。これによりAIコーディングエージェント(Claude Code、Codex等)が以下を実行できるようになります: - `$` プレフィックス **CEOディレクティブ** の解釈と優先タスクの委任 - Claw-Empire REST APIを呼び出してタスク作成、エージェント割り当て、ステータス報告 - 安全な並行開発のための独立したgit worktree環境での作業 ```bash # デフォルト:AGENTS.mdの場所を自動検出 pnpm setup # カスタムパス pnpm setup -- --agents-path /path/to/your/AGENTS.md # カスタムポート pnpm setup -- --port 8790 ``` ### OpenClaw連携セットアップ(Telegram/WhatsApp/Discord/Google Chat/Slack/Signal/iMessage) `install.sh` / `install.ps1`(または `scripts/openclaw-setup.*`)は、可能な場合に `OPENCLAW_CONFIG` を自動検出して `.env` に設定します。 推奨 `.env` 形式: `OPENCLAW_CONFIG` は絶対パス(引用符なし推奨)。 `v1.0.5` では互換性のため、引用符と先頭 `~` もランタイムで正規化します。 デフォルトパス: | OS | パス | | ----------------- | --------------------------------------- | | **macOS / Linux** | `~/.openclaw/openclaw.json` | | **Windows** | `%USERPROFILE%\.openclaw\openclaw.json` | 手動実行: ```bash # macOS / Linux bash scripts/openclaw-setup.sh --openclaw-config ~/.openclaw/openclaw.json ``` ```powershell # Windows PowerShell powershell -ExecutionPolicy Bypass -File .\scripts\openclaw-setup.ps1 -OpenClawConfig "$env:USERPROFILE\.openclaw\openclaw.json" ``` セッション確認: ```bash curl -s http://127.0.0.1:8790/api/gateway/targets ``` ### `$` コマンドによるOpenClawチャット依頼ロジック チャットメッセージが `$` で始まる場合、Claw-EmpireはCEOディレクティブとして扱います。 1. オーケストレーターがチームリーダー会議を開くか確認します。 2. オーケストレーターが作業対象のプロジェクト(`project_path` または `project_context`)を確認します。 3. `$` プレフィックス付きのメッセージを `x-inbox-secret` ヘッダー付きで `POST /api/inbox` に送信します。 4. 会議を省略する場合は `"skipPlannedMeeting": true` を付けます。 5. サーバーは `directive` として保存し、全社共有後に企画チーム(およびメンション部門)へ委任します。 `x-inbox-secret` が欠落、または `INBOX_WEBHOOK_SECRET` と不一致の場合、サーバーは `401` を返します。 サーバー側で `INBOX_WEBHOOK_SECRET` が未設定の場合は `503` を返します。 会議あり: ```bash curl -X POST http://127.0.0.1:8790/api/inbox \ -H "content-type: application/json" \ -H "x-inbox-secret: $INBOX_WEBHOOK_SECRET" \ -d '{"source":"telegram","author":"ceo","text":"$金曜までにQA承認付きでv0.2をリリース","project_path":"/workspace/my-project"}' ``` 会議なし: ```bash curl -X POST http://127.0.0.1:8790/api/inbox \ -H "content-type: application/json" \ -H "x-inbox-secret: $INBOX_WEBHOOK_SECRET" \ -d '{"source":"telegram","author":"ceo","text":"$本番ログイン不具合を今すぐホットフィックス","skipPlannedMeeting":true,"project_context":"既存の climpire プロジェクト"}' ``` ブラウザで開く: | URL | 説明 | | ------------------------------- | ---------------------------------- | | `http://127.0.0.1:8800` | フロントエンド(Vite開発サーバー) | | `http://127.0.0.1:8790/healthz` | APIヘルスチェック | --- ## 環境変数 `.env.example` を `.env` にコピーしてください。すべてのシークレットはローカルに保管されます — `.env` はコミットしないでください。 | 変数 | 必須 | 説明 | | ----------------------------------- | --------------------------- | --------------------------------------------------------------------------------------------- | | `OAUTH_ENCRYPTION_SECRET` | **必須** | SQLite内のOAuthトークンとメッセンジャーチャネルトークンをAES-256-GCMで暗号化 | | `SESSION_SECRET` | フォールバック | `OAUTH_ENCRYPTION_SECRET` 未設定時のみ使うレガシーフォールバックキー | | `PORT` | 任意 | サーバーポート(デフォルト: `8790`) | | `HOST` | 任意 | バインドアドレス(デフォルト: `127.0.0.1`) | | `API_AUTH_TOKEN` | 推奨 | ループバック以外のAPI/WebSocketアクセス向けBearerトークン | | `INBOX_WEBHOOK_SECRET` | **`/api/inbox` 利用時必須** | `x-inbox-secret` ヘッダーと一致させる共有シークレット | | `OPENCLAW_CONFIG` | OpenClaw利用時推奨 | ゲートウェイターゲット検出/チャット連携で使う `openclaw.json` の絶対パス | | `DB_PATH` | 任意 | SQLiteデータベースパス(デフォルト: `./claw-empire.sqlite`) | | `LOGS_DIR` | 任意 | ログディレクトリ(デフォルト: `./logs`) | | `OAUTH_GITHUB_CLIENT_ID` | 任意 | GitHub OAuth Appクライアント ID | | `OAUTH_GITHUB_CLIENT_SECRET` | 任意 | GitHub OAuth Appクライアントシークレット | | `OAUTH_GOOGLE_CLIENT_ID` | 任意 | Google OAuthクライアントID | | `OAUTH_GOOGLE_CLIENT_SECRET` | 任意 | Google OAuthクライアントシークレット | | `OPENAI_API_KEY` | 任意 | OpenAI APIキー(Codex用) | | `REVIEW_MEETING_ONESHOT_TIMEOUT_MS` | 任意 | 会議 one-shot タイムアウト(ミリ秒)。既定値 `65000`、後方互換として `600` 以下は秒として解釈 | | `UPDATE_CHECK_ENABLED` | 任意 | インアプリ更新確認バナーを有効化(デフォルト `1`、`0` で無効) | | `UPDATE_CHECK_REPO` | 任意 | 更新確認に使う GitHub リポジトリスラッグ(デフォルト: `GreenSheep01201/claw-empire`) | | `UPDATE_CHECK_TTL_MS` | 任意 | 更新確認キャッシュ TTL(ミリ秒、デフォルト: `1800000`) | | `UPDATE_CHECK_TIMEOUT_MS` | 任意 | GitHub リクエストタイムアウト(ミリ秒、デフォルト: `4000`) | | `AUTO_UPDATE_ENABLED` | 任意 | `settings.autoUpdateEnabled` が未設定時に使う自動更新の既定値(デフォルト `0`) | `API_AUTH_TOKEN` を有効化した場合、リモートブラウザクライアントは実行時にトークンを入力します。トークンは `sessionStorage` のみに保存され、Viteビルド成果物には埋め込まれません。 `OPENCLAW_CONFIG` は絶対パス推奨で、`v1.0.5` では引用符/先頭 `~` も自動正規化されます。 --- ## 実行モード ```bash # 開発モード(ローカルのみ、推奨) pnpm dev:local # 127.0.0.1にバインド # 開発モード(ネットワークアクセス可) pnpm dev # 0.0.0.0にバインド # プロダクションビルド pnpm build # TypeScriptチェック + Viteビルド pnpm start # API/バックエンドサーバーを起動(本番モードでは dist を配信) # ヘルスチェック curl -fsS http://127.0.0.1:8790/healthz ``` ### CI検証(現在のPRパイプライン) すべての Pull Request で `.github/workflows/ci.yml` は次の順に実行されます。 1. ワークフローファイルの hidden/bidi Unicode ガード 2. `pnpm install --frozen-lockfile` 3. `pnpm run format:check` 4. `pnpm run lint` 5. `pnpm exec playwright install --with-deps` 6. `pnpm run test:ci`(`test:web --coverage` + `test:api --coverage` + `test:e2e`) 注: `pnpm run test:e2e` は隔離された `.tmp/e2e-runtime` DB を起動し、実行後に再度クリアします。すでに起動しているローカル `8810` サーバーを意図的に再利用したい場合だけ `PW_REUSE_EXISTING_SERVER=1` を設定してください。 PR 前のローカル推奨チェック: ```bash pnpm run format:check pnpm run lint pnpm run build pnpm run test:ci ``` ### 通信QAチェック(v1.1.6) ```bash # 個別チェック pnpm run test:comm:llm pnpm run test:comm:oauth pnpm run test:comm:api # 統合チェック(互換エントリ含む) pnpm run test:comm:suite pnpm run test:comm-status ``` `test:comm:suite` は機械可読な証跡を `logs/` に、要約レポートを `docs/` に出力します。 ### プロジェクトパス QA スモーク(v1.1.6) ```bash # API 認証トークンが必要 QA_API_AUTH_TOKEN="" pnpm run test:qa:project-path ``` `test:qa:project-path` は、パス補助 API、プロジェクト作成フロー、重複 `project_path` 競合レスポンス、クリーンアップ動作を検証します。 ### インアプリ更新バナー GitHub により新しいリリースが公開されると、Claw-Empire は UI 上部に pull 手順とリリースノートリンク付きバナーを表示します。 - Windows PowerShell: `git pull; pnpm install` - macOS/Linux シェル: `git pull && pnpm install` - pull/install 後にサーバーを再起動してください。 ### 自動更新(セーフモード、オプトイン) リリース同期を自動化する場合は、Settings の `Auto Update (Global)` を有効化してください。 - `GET /api/update-auto-status` — 自動更新の実行状態/設定状態を取得(**認証必須**) - `POST /api/update-auto-config` — 自動更新トグル(`enabled`)を再起動なしで即時反映(**認証必須**) - `POST /api/update-apply` — 手動で更新パイプラインを実行(`dry_run` / `force` / `force_confirm`、**認証必須**) - `dirty_worktree`, `channel_check_unavailable` ガードは `force` でも迂回できません。 既定値は引き続き **OFF** です。`AUTO_UPDATE_CHANNEL` が不正な値の場合、サーバーは警告ログを出し `patch` にフォールバックします。 --- ## プロバイダー設定(CLI / OAuth / API) ### 公式 API プリセット **Settings > API** タブでは、次の4つの公式 direct API プリセットをすぐに追加できます。 - `OpenCode Go (OpenAI)` -> `https://opencode.ai/zen/go/v1` - `OpenCode Go (Anthropic)` -> `https://opencode.ai/zen/go/v1` - `Bailian Coding Plan (OpenAI)` -> `https://coding-intl.dashscope.aliyuncs.com/v1` - `Bailian Coding Plan (Anthropic)` -> `https://coding-intl.dashscope.aliyuncs.com/apps/anthropic` メモ: - Bailian Coding Plan の API キーは `sk-sp-` プレフィックスで始まる必要があります。 - これらのプリセットは保存直後に fallback モデル一覧をシードするため、live `/models` 検出が不完全でもすぐに割り当てできます。 - direct API プリセットは `glm-5`、`kimi-k2.5`、`minimax-m2.5` のような実際の endpoint model id を使います。`opencode-go/` のような OpenCode CLI モデル ID は使いません。 - Bailian Coding Plan のキーは対話型コーディングツール向けに案内されるものです。他用途へ流用する前に公式ドキュメントを確認してください。 - assign モーダルは `development` を既定の基準線として使い、初期セットアップが完了して hydrate 済みの office pack もあわせて表示します。 Claw-Empireは次の3種類のプロバイダー接続に対応しています: - **CLIツール** — ローカルCLIをインストールしてプロセス実行 - **OAuthアカウント** — 対応プロバイダーを安全なトークン連携で接続 - **直接APIキー** — **Settings > API** タブから外部LLM APIへ接続 CLIモードを利用する場合は、少なくとも一つをインストールしてください: | プロバイダー | インストール | 認証 | | ------------------------------------------------------------- | ---------------------------------------- | ------------------------------ | | [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | `npm i -g @anthropic-ai/claude-code` | `claude`(プロンプトに従う) | | [Codex CLI](https://github.com/openai/codex) | `npm i -g @openai/codex` | `.env`に`OPENAI_API_KEY`を設定 | | [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `npm i -g @google/gemini-cli` | 設定パネルからOAuth認証 | | [OpenCode](https://github.com/opencode-ai/opencode) | `npm i -g opencode` | プロバイダー固有の設定 | | [Kimi Code](https://github.com/MoonshotAI/kimi-cli) | `uv tool install --python 3.13 kimi-cli` | `kimi auth login` | アプリ内の **Settings > CLI Tools** パネルでプロバイダーとモデルを設定してください。 または、CLI をインストールせずに **Settings > API** タブからエージェントを外部 LLM API に接続することも可能です。APIキーはローカルSQLiteデータベースに暗号化(AES-256-GCM)して保存されます — `.env` やソースコードには含まれません。 スキル学習/解除の自動化は、現在CLI連携プロバイダーを対象に設計されています。 --- ## プロジェクト構成 ``` claw-empire/ ├── .github/ │ └── workflows/ │ └── ci.yml # PR CI(Unicodeガード、format、lint、test) ├── server/ │ ├── index.ts # バックエンドエントリポイント │ ├── server-main.ts # ランタイム配線/ブートストラップ │ ├── modules/ # routes/workflow/bootstrap lifecycle │ ├── test/ # バックエンドテスト設定/ヘルパー │ └── vitest.config.ts # バックエンド単体テスト設定 ├── src/ │ ├── app/ # アプリシェル、レイアウト、状態オーケストレーション │ ├── api/ # フロントエンド API モジュール │ ├── components/ # UI(office/taskboard/chat/settings) │ ├── hooks/ # polling/websocket フック │ ├── test/ # フロントエンドテスト設定 │ ├── types/ # フロントエンド型定義 │ ├── App.tsx │ ├── api.ts │ └── i18n.ts ├── tests/ │ └── e2e/ # Playwright E2E シナリオ ├── public/sprites/ # ピクセルアートエージェントスプライト ├── scripts/ │ ├── setup.mjs # 環境/ブートストラップ設定 │ ├── auto-apply-v1.0.5.mjs # 起動時マイグレーション補助 │ ├── openclaw-setup.sh # ワンクリックセットアップ(macOS/Linux) │ ├── openclaw-setup.ps1 # ワンクリックセットアップ(Windows PowerShell) │ ├── prepare-e2e-runtime.mjs │ ├── preflight-public.sh # リリース前セキュリティチェック │ └── generate-architecture-report.mjs ├── install.sh # scripts/openclaw-setup.sh のラッパー ├── install.ps1 # scripts/openclaw-setup.ps1 のラッパー ├── docs/ # 設計・アーキテクチャドキュメント ├── AGENTS.md # ローカルエージェント/オーケストレーション規則 ├── CONTRIBUTING.md # ブランチ/PR/レビュー方針 ├── eslint.config.mjs # Flat ESLint 設定 ├── .env.example # 環境変数テンプレート └── package.json ``` --- ## セキュリティ Claw-Empireはセキュリティを重視した設計になっています: - **ローカルファーストアーキテクチャ** — すべてのデータをSQLiteにローカル保存;外部クラウドサービス不要 - **OAuth + メッセンジャートークンの暗号化** — ユーザーのOAuthトークンとメッセンジャーチャネルトークンは**サーバー側のSQLiteにのみ保存**され、AES-256-GCM + `OAUTH_ENCRYPTION_SECRET`(`SESSION_SECRET` フォールバック)で暗号化されます。ブラウザにリフレッシュトークンが渡ることはありません - **ビルトインOAuth Client ID** — ソースコードに埋め込まれたGitHub・Google OAuth client ID/secretは**公開OAuthアプリ認証情報**であり、ユーザーシークレットではありません。[Googleのドキュメント](https://developers.google.com/identity/protocols/oauth2/native-app)によると、インストール型/デスクトップアプリのclient secretは「シークレットとして扱われない」とされています。これはオープンソースアプリ(VS Code、Thunderbird、GitHub CLI等)の標準的な慣行です。これらの認証情報はアプリ自体を識別するだけであり、個人トークンは常に別途暗号化されます - **ソースコードに個人認証情報なし** — すべてのユーザー固有トークン(GitHub、Google OAuth)はローカルSQLiteに暗号化して保存され、ソースコードには含まれません - **リポジトリにシークレットを含まない** — 包括的な `.gitignore` が `.env`、`*.pem`、`*.key`、`credentials.json` などをブロック - **プリフライトセキュリティチェック** — 公開リリース前に `pnpm run preflight:public` を実行し、ワーキングツリーとgit履歴の両方で漏洩したシークレットをスキャン - **デフォルトでローカルホスト** — 開発サーバーは `127.0.0.1` にバインドされ、ネットワークに公開されない ## APIドキュメント & セキュリティ要約 - **APIドキュメント** — エンドポイント概要/利用方法は [`docs/api.md`](docs/api.md)、スキーマ/ツール連携は [`docs/openapi.json`](docs/openapi.json) を参照してください。 - **セキュリティポリシー** — 脆弱性報告/方針は [`SECURITY.md`](SECURITY.md) を確認し、公開リリース前は `pnpm run preflight:public` の実行を推奨します。 --- ## コントリビューション コントリビューションを歓迎します!以下の手順でお願いします: 1. リポジトリをフォーク 2. `dev` を基準にフィーチャーブランチを作成(`git checkout -b feature/amazing-feature`) 3. 変更をコミット(`git commit -m 'Add amazing feature'`) 4. PR 前にローカル検証を実行: - `pnpm run format:check` - `pnpm run lint` - `pnpm run build` - `pnpm run test:ci` 5. ブランチにプッシュ(`git push origin feature/amazing-feature`) 6. Pull Request は原則 `dev` ブランチ宛てで作成(外部コントリビューター向け統合ブランチ) 7. `main` はメンテナー承認済みの緊急ホットフィックス時のみ使用し、その後 `main -> dev` をバックマージ 詳細ポリシー: [`CONTRIBUTING.md`](CONTRIBUTING.md) --- ## ライセンス [Apache 2.0](LICENSE) — 個人・商用利用ともに無料。 ---
**ピクセルと情熱で作られています。** _Claw-Empire — AIエージェントたちが働く場所。_