| 1 | <!-- source: README.md sha256:a87c9f323f35 --> |
| 2 | # Codewhale |
| 3 | |
| 4 | ターミナルで動くオープンソースのコーディングエージェント — モデルはあなたが持ち込む。 |
| 5 | |
| 6 | Codewhale は DeepSeek のためのネイティブ体験として始まりました。そこから、コミュニティ主導のプロジェクトへと成長しています。広がり続ける国際的なコミュニティに合い、できるだけ多くのモデルとプロバイダに対応する、ひとつのコーディングハーネスです — オープンモデルを最優先に、ホスト型でもローカルでも、どれかを特別扱いすることはありません。 |
| 7 | |
| 8 | プロバイダ、モデル、タスクを渡すと、コードを読み、ファイルを編集し、コマンドを実行し、自分の作業を確認して、タスクが完了するかあなたの手が必要になった時点で止まります。タスクの途中でも `/model` でモデルを切り替えられます。対話的な作業には TUI を、スクリプトと CI には `codewhale exec` を。Rust 製、MIT ライセンスで、あなたのマシン上で動きます。 |
| 9 | |
| 10 | 私たちは常にコントリビューターと改善の方法を探しています。使っているモデルやプロバイダが見当たらないとき、あるいは何かが壊れたときは、それを知らせてもらえることが最も役に立つことのひとつです — [コントリビューション](#コントリビューション)を見てください。 |
| 11 | |
| 12 | [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) · [codewhale.net](https://codewhale.net/) · [Docs](docs) · [Changelog](CHANGELOG.md) · [Discord](https://discord.gg/37gfS3ksug) |
| 13 | |
| 14 | [](https://github.com/Hmbown/CodeWhale/actions/workflows/ci.yml) |
| 15 | [](https://crates.io/crates/codewhale-cli) |
| 16 | [](https://www.npmjs.com/package/codewhale) |
| 17 | [](https://discord.gg/37gfS3ksug) |
| 18 | |
| 19 |  |
| 20 | |
| 21 | ## インストール |
| 22 | |
| 23 | ```bash |
| 24 | npm install -g codewhale |
| 25 | ``` |
| 26 | |
| 27 | Cargo、Docker、Nix、Scoop、ビルド済みアーカイブ、Android/Termux、そして GitHub に到達できないユーザー向けの CNB ミラーについては [docs/INSTALL.md](docs/INSTALL.md) で扱っています。`deepseek-tui` からの移行なら、設定とセッションはそのまま引き継がれます — [docs/REBRAND.md](docs/REBRAND.md) を参照してください。 |
| 28 | |
| 29 | ## 使い方 |
| 30 | |
| 31 | ```bash |
| 32 | codewhale auth set --provider deepseek # or export ANTHROPIC_API_KEY, etc. |
| 33 | codewhale # open the TUI |
| 34 | codewhale exec "fix the failing test" # headless |
| 35 | codewhale web # local browser client on 127.0.0.1 |
| 36 | ``` |
| 37 | |
| 38 | |
| 39 | TUI では、`/model` がプロバイダとモデルをまとめて切り替え、`/fleet` がワーカーのチームを走らせ、`/undo` が直前のターンを取り消し、`/restore <N>` がワークスペースを以前のスナップショットへ巻き戻します(引数なしの `/restore` は一覧を表示するだけです)。入力欄が空のとき、`Tab` は Plan / Act / Operate を順に切り替えます。入力欄に文字があるときの `Tab` はスラッシュコマンドと `@` メンションの補完になります。`Shift+Tab` はいつでも Ask / Auto-Review / Full Access の権限スタンスを順に切り替えます。`!` は Shell コマンドを通常の承認経路で実行します。 |
| 40 | |
| 41 | ## できること |
| 42 | |
| 43 | - **どのモデルでも、どのプロバイダでも。** DeepSeek、Claude、GPT、Kimi、GLM をはじめ 30 以上のプロバイダ、そしてキー不要のあなた自身の vLLM・SGLang・Ollama が、すべてひとつのランタイムとひとつのツール群を通って動きます。コンテキスト予算と価格は実際のルートに由来し、不明な価格は $0 ではなく不明と表示されます。 |
| 44 | - **許可するまでは読み取り専用。** Plan モードはファイルを変更せず、リスクのあるコマンドは承認でゲートされます。OS サンドボックスが実際にコマンドをラップするとき、Codewhale はそれを明示します。macOS では利用可能な Seatbelt、Linux ではオプトインの bubblewrap です。リポジトリの `constitution.json` は書き込みホールドへとコンパイルされ、Full Access でもスキップできません。 |
| 45 | - **再開できる作業。** Fleet はすべてのステップを追記専用の台帳に記録するので、`fleet resume` で止めたところから再開できます。 |
| 46 | |
| 47 | ## さらに詳しく |
| 48 | |
| 49 | - [docs/PROVIDERS.md](docs/PROVIDERS.md) — ホスト型・ゲートウェイ・ローカル |
| 50 | まで、すべてのプロバイダルート |
| 51 | - [docs/FLEET.md](docs/FLEET.md) — Fleet、台帳、再開 |
| 52 | - [docs/WORKFLOW_EXPERIMENTAL_SEARCH.md](docs/WORKFLOW_EXPERIMENTAL_SEARCH.md) — Workflow 内の凍結済み・プロバイダ中立の実験的検索 |
| 53 | - [docs/CONFIGURATION.md](docs/CONFIGURATION.md) — `config.toml`、フック、 |
| 54 | constitution |
| 55 | - [docs/AUTHORIZATION_ORDER.md](docs/AUTHORIZATION_ORDER.md) — モード、フック、 |
| 56 | 権限ルール、安全フロア、リポジトリルール、承認、サンドボックスの組み合わせ方 |
| 57 | - [docs/HOOKS.md](docs/HOOKS.md) — 11 個の TUI ライフサイクルフックイベント、 |
| 58 | そのペイロード、ターンを誘導できる 3 イベント（`codewhale exec` と CLI |
| 59 | サブコマンドではフックは発火しません） |
| 60 | - [docs/WEB.md](docs/WEB.md) — ループバック専用の組み込みブラウザクライアントと |
| 61 | ワンタイム認証境界 |
| 62 | |
| 63 | その他 — モード、キーバインド、サンドボックスの詳細、MCP、ランタイム API、 |
| 64 | アーキテクチャ — は [docs](docs) と [codewhale.net](https://codewhale.net/) |
| 65 | にあります。 |
| 66 | |
| 67 | ## コントリビューション |
| 68 | |
| 69 | Issue、PR、再現手順、ログ、機能要望は、どれもここでは本物のプロジェクト作業です。初めてのコントリビューションも歓迎します。PR がそのままマージできない場合、メンテナは使える部分を harvest し、作者のクレジットは残ります — コミットにも、changelog にも、[docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md) にも。 |
| 70 | |
| 71 | - [Open issues](https://github.com/Hmbown/CodeWhale/issues) — 最初のコントリビューションに向くものはここにあります |
| 72 | - [CONTRIBUTING.md](CONTRIBUTING.md) — 開発環境のセットアップと PR の流れ |
| 73 | - [docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md) — このプロジェクトを形づくってきた全員 |
| 74 | - [Buy me a coffee](https://www.buymeacoffee.com/hmbown) |
| 75 | |
| 76 | プロジェクトの出発点となったモデルとサポートを提供してくれた [DeepSeek](https://github.com/deepseek-ai)、「鯨兄弟」ファミリーに迎え入れてくれた [DataWhale](https://github.com/datawhalechina) 🐋、そしてターミナルエージェント体験で協力してくれている [OpenWarp](https://github.com/zerx-lab/warp) と [Open Design](https://github.com/nexu-io/open-design) に感謝します。 |
| 77 | |
| 78 | ## ライセンス |
| 79 | |
| 80 | [MIT](LICENSE)。独立したコミュニティプロジェクトであり、いかなるモデルプロバイダとも提携していません。 |
| 81 | |
| 82 | [](https://www.star-history.com/?repos=Hmbown%2FCodeWhale&type=date) |
| 83 |