| 1 | <!-- source: README.md sha256:604da19bff2c --> |
| 2 | <div align="center"> |
| 3 | |
| 4 | <picture> |
| 5 | <source media="(prefers-color-scheme: dark)" srcset="brand/wordmark-inverted.svg"> |
| 6 | <img src="brand/wordmark.svg" alt="Codewhale" width="320"> |
| 7 | </picture> |
| 8 | |
| 9 | **どのモデルでも使える、オープンソースのコーディングエージェント。** |
| 10 | |
| 11 | Codewhale はプロジェクトを読み、ファイルを編集し、コマンドを実行して、自分の作業を確認します。 |
| 12 | ターミナル上で、あなたが選んだホスト型またはローカルのモデルを使います。 |
| 13 | |
| 14 | [](https://github.com/codewhale-hq/CodeWhale/actions/workflows/ci.yml) |
| 15 | [](https://crates.io/crates/codewhale-cli) |
| 16 | [](https://www.npmjs.com/package/codewhale) |
| 17 | [](LICENSE) |
| 18 | [](https://discord.gg/37gfS3ksug) |
| 19 | |
| 20 | [ウェブサイト](https://codewhale.net) · [ドキュメント](docs/README.md) · [変更履歴](CHANGELOG.md) · [コントリビュート](CONTRIBUTING.md) |
| 21 | |
| 22 | [English](README.md) · [简体中文](README.zh-CN.md) · [Tiếng Việt](README.vi.md) · [Bahasa Indonesia](README.id.md) · [한국어](README.ko-KR.md) · [Español](README.es-419.md) · [Português](README.pt-BR.md) · [Русский](README.ru.md) · [Українська](README.uk.md) · [Français](README.fr.md) · [Deutsch](README.de.md) · [繁體中文](README.zh-TW.md) · [हिन्दी](README.hi.md) · [Türkçe](README.tr.md) · [Italiano](README.it.md) · [Polski](README.pl.md) · [العربية](README.ar.md) · [Català](README.ca.md) |
| 23 | |
| 24 | <img src="web/public/codewhale-tui-8ba2bbf.png" alt="Codewhale のターミナルセッション" width="760"> |
| 25 | |
| 26 | <sub>新規インストール直後の実際のターミナル画面です。演出は加えていません。</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## インストール |
| 31 | |
| 32 | macOS と Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | インストーラーはチェックサム検証済みのバイナリを `~/.local/bin` にダウンロードします。 |
| 39 | その後 `codewhale` が "command not found" と表示される場合は、インストーラーが出力する PATH 用の 1 行を実行するか、 |
| 40 | [PATH に追加する](docs/INSTALL.md#put-it-on-your-path)を参照してください。 |
| 41 | アップグレードはいつでも `codewhale update` で行えます。 |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows、npm、Cargo、その他のインストール方法</b></summary> |
| 45 | |
| 46 | ```bash |
| 47 | winget install HunterBown.CodeWhale # Windows x64 (or Scoop, or the installer from GitHub Releases) |
| 48 | npm install -g codewhale # wraps the same release binaries |
| 49 | cargo install codewhale-cli --locked # build from crates.io |
| 50 | ``` |
| 51 | |
| 52 | Docker、Nix、Linux 上の Homebrew、Android/Termux、チェックサム検証付きの手動ダウンロード、 |
| 53 | 任意の CNB ミラーについては[インストールガイド](docs/INSTALL.md)で説明しています。 |
| 54 | 方法は 1 つだけ選んでください。1 台のマシンに複数の方法でインストールすると、`PATH` の中で競合します。 |
| 55 | |
| 56 | </details> |
| 57 | |
| 58 | ## クイックスタート |
| 59 | |
| 60 | 1. **プロジェクトを開く。** 作業したいフォルダーで `codewhale` を実行します。 |
| 61 | 2. **モデルを接続する。** `/provider`(または `F3`)を実行して、ホスト型のキーを追加するか、ローカルランタイムを選びます。 |
| 62 | チャットモデルを載せた Ollama がすでに起動していれば、Codewhale は自動的にそれへ切り替わります。モデルの変更は `/model` で行います。 |
| 63 | 3. **具体的なタスクを渡す。** |
| 64 | |
| 65 | ```text |
| 66 | Fix the failing tests and explain what changed. |
| 67 | ``` |
| 68 | |
| 69 | 同じタスクを、スクリプトや CI ジョブからヘッドレスで実行することもできます。 |
| 70 | |
| 71 | ```bash |
| 72 | codewhale exec "fix the failing tests and explain what changed" |
| 73 | ``` |
| 74 | |
| 75 | コマンドとキーボードショートカットは `/help` で確認できます。 |
| 76 | |
| 77 | ## 実行方法 |
| 78 | |
| 79 | どのクライアントも同じローカルの Codewhale Runtime を操作するため、セッション、ツール、権限はどこでも同じように動作します。 |
| 80 | |
| 81 | | コマンド | 内容 | |
| 82 | | --- | --- | |
| 83 | | `codewhale` | 対話型のターミナルインターフェース | |
| 84 | | `codewhale exec "…"` | スクリプトや CI からヘッドレスで 1 ターン実行し、JSON をストリーミング出力 | |
| 85 | | `codewhale web` | `127.0.0.1` で動作する、同梱の[ローカルブラウザークライアント](docs/WEB.md) | |
| 86 | | `codewhale review --pr N` | 参考情報としての[プルリクエストレビュー](docs/GITHUB_ACTION.md)。投稿は任意で有効化 | |
| 87 | | Runtime API | スレッド、イベント、承認のための[ローカル HTTP API](docs/RUNTIME_API.md) | |
| 88 | |
| 89 | ネイティブのデスクトップアプリ(GPUI)は、サインインして使う製品クライアントとして開発中です。提供状況は |
| 90 | [製品ページ](https://codewhale.net/en/product)をご覧ください。コミュニティが保守している |
| 91 | [VS Code 拡張機能](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode)は、 |
| 92 | サイドバーから同じ Runtime に接続します([ソース](https://github.com/HengQuWorld/CodeWhale-VSCode))。 |
| 93 | |
| 94 | ## 主な機能 |
| 95 | |
| 96 | - **どのモデルでも、ロックインなし。** Anthropic、DeepSeek、Google、Mistral、Moonshot、OpenAI、OpenRouter、xAI など、 |
| 97 | 40 以上のプロバイダー経路を内蔵。OpenAI 互換のエンドポイントや、Ollama、vLLM、SGLang 経由のローカルモデルも使えます。 |
| 98 | [プロバイダー](docs/PROVIDERS.md) |
| 99 | - **主導権はあなたに。** Plan モードは何も変更せずに調査だけを行い、Work と Operate は変更を加えます。 |
| 100 | 承認ポスチャーがツール呼び出しにあなたの許可を求めるタイミングを決め、`/undo` と `/restore` でワークスペースの変更を元に戻せます。 |
| 101 | `/receipts` はセッション内のすべてのファイル、コマンド、承認を一覧表示します。[モード](docs/MODES.md) · |
| 102 | [レシート](docs/RECEIPTS.md) |
| 103 | - **長い作業のために。** 持続する `/goal` を設定し、範囲を区切った作業を |
| 104 | [サブエージェント](docs/SUBAGENTS.md)に任せ、支出の事前チェック付きで監督される |
| 105 | [エージェントチーム](docs/FLEET.md)を動かし、あるいはリポジトリに含められる |
| 106 | [ワークフロー](docs/WORKFLOW_AUTHORING.md)としてスクリプト化できます。 |
| 107 | - **普段使っているものを拡張。** [MCP サーバー](docs/MCP.md)を接続し、 |
| 108 | [スキル](docs/SKILLS.md)と[プラグイン](docs/PLUGINS.md)をインストールし、 |
| 109 | セッションやツールのイベントで[フック](docs/HOOKS.md)を実行し、既存の |
| 110 | [Claude Code プラグイン](docs/CLAUDE_PLUGIN_COMPAT.md)も読み込めます。 |
| 111 | - **Computer Use。** 同梱のプラグインが、他のアプリケーションを観察・操作するツールを追加します。 |
| 112 | 使用前にアクセス範囲を確認し、有効化してください。 |
| 113 | [ガイド](crates/tui/plugins/computer-use/README.md) |
| 114 | |
| 115 | ## モードと権限 |
| 116 | |
| 117 | | | 切り替え方法 | 選択肢 | |
| 118 | | --- | --- | --- | |
| 119 | | **モード(Mode)**: エージェントが何をしているか | `Tab` または `/mode` | Plan(調査のみ、変更なし)· Work(編集と実行)· Operate(計画され検証されたステップで目標を進める) | |
| 120 | | **ポスチャー(Posture)**: いつ先に確認するか | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 121 | |
| 122 | Full Access でも、ハードなポリシー境界は守られます。 |
| 123 | 各選択肢については[モードと権限のガイド](docs/MODES.md)で説明しています。 |
| 124 | |
| 125 | ## 安全性 |
| 126 | |
| 127 | Codewhale はあなたのマシン上で、あなたが与えたアクセス権の範囲で動作します。承認ポスチャーとリポジトリのルールがエージェントにできることを制限し、 |
| 128 | 対応環境ではコマンドは OS のサンドボックス内で実行されます(macOS は Seatbelt、Linux の bubblewrap は任意で有効化)。 |
| 129 | `/preview-request` は、何かを送信する前に、機密情報を伏せたリクエストそのものを表示します。 |
| 130 | 価格が不明なモデルは「不明」のまま扱われ、無料として報告されることはありません。 |
| 131 | |
| 132 | [認可の順序](docs/AUTHORIZATION_ORDER.md)、 |
| 133 | [サンドボックス](docs/SANDBOX.md)、[テレメトリ](docs/TELEMETRY.md)を参照してください。 |
| 134 | 利用回数の集計は既定で有効で、`codewhale config set telemetry false` で無効にできます。 |
| 135 | |
| 136 | ## ドキュメント |
| 137 | |
| 138 | | まずはここから | さらに詳しく | |
| 139 | | --- | --- | |
| 140 | | [インストール](docs/INSTALL.md) | [設定](docs/CONFIGURATION.md) | |
| 141 | | [プロバイダーとローカルモデル](docs/PROVIDERS.md) | [アーキテクチャ](docs/ARCHITECTURE.md) | |
| 142 | | [モードと権限](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 143 | | [キーバインド](docs/KEYBINDINGS.md) | [プラグイン作成](docs/PLUGIN_AUTHORING.md) | |
| 144 | | [GitHub PR レビュー](docs/GITHUB_ACTION.md) | [すべてのドキュメント](docs/README.md) | |
| 145 | |
| 146 | ## コミュニティ |
| 147 | |
| 148 | バグ報告、機能のアイデア、プルリクエストを歓迎します。Codewhale を何か月も使っている方も、初めて試す方も同じです。 |
| 149 | プロバイダーが足りない、あるいはワークフローが使いにくいと感じたら、 |
| 150 | [issue を作成](https://github.com/codewhale-hq/CodeWhale/issues/new/choose)するか、 |
| 151 | [プルリクエストを送って](CONTRIBUTING.md)ください。初めてのコントリビュートも歓迎で、 |
| 152 | 取り込まれた作業の貢献者としてのクレジットは保たれます。 |
| 153 | [リポジトリの構成](CONTRIBUTING.md#project-structure)が最初の手がかりになります。 |
| 154 | |
| 155 | [Discord](https://discord.gg/37gfS3ksug) に参加するか、WeChat で Hunter |
| 156 | (`hunterbown`)を追加して、Whale Brothers グループへの参加を依頼してください。 |
| 157 | |
| 158 | ## 歴史とライセンス |
| 159 | |
| 160 | Codewhale は `deepseek-tui` として始まり、今もそのプロジェクトの設定とセッションを読み込みます。 |
| 161 | 現在は特定のプロバイダーに依存せず、独立して保守されており、どのモデルプロバイダーとも提携していません。 |
| 162 | [すべてのコントリビューター](docs/CONTRIBUTORS.md)と、成長を支えてくれたオープンソースコミュニティに感謝します。 |
| 163 | |
| 164 | [MIT](LICENSE)。他のオープンソースプロジェクトから改変して取り入れた部分は、 |
| 165 | [サードパーティ通知](docs/THIRD_PARTY_NOTICES.md)に記載しています。 |
| 166 |