Skip to content

README.ja-JP.md

Latest commit

 

History

History
171 lines (127 loc) · 11.7 KB

README.ja-JP.md

File metadata and controls

171 lines (127 loc) · 11.7 KB
Raw
Codewhale

どのモデルでも使える、オープンソースのコーディングエージェント。

Codewhale はプロジェクトを読み、ファイルを編集し、コマンドを実行して、自分の作業を確認します。 ターミナル上で、あなたが選んだホスト型またはローカルのモデルを使います。

CI crates.io npm License: MIT Discord

ウェブサイト · ドキュメント · 変更履歴 · コントリビュート

English · 简体中文 · Tiếng Việt · Bahasa Indonesia · 한국어 · Español · Português · Русский · Українська · Français · Deutsch · 繁體中文 · हिन्दी · Türkçe · Italiano · Polski · العربية · Català

Codewhale のターミナルセッション

設定済みのローカルデモセッションから取得した、実際の Codewhale ターミナル画面です。

インストール

macOS と Linux:

curl -fsSL https://codewhale.net/install.sh | sh

インストーラーはチェックサム検証済みのバイナリを ~/.local/bin にダウンロードします。 その後 codewhale が "command not found" と表示される場合は、インストーラーが出力する PATH 用の 1 行を実行するか、 PATH に追加するを参照してください。 アップグレードはいつでも codewhale update で行えます。

Windows、npm、Cargo、その他のインストール方法 
winget install HunterBown.CodeWhale  # Windows x64 (or Scoop, or the installer from GitHub Releases)
npm install -g codewhale            # wraps the same release binaries
cargo install codewhale-cli --locked  # build from crates.io

Docker、Nix、Linux 上の Homebrew、Android/Termux、チェックサム検証付きの手動ダウンロード、 任意の CNB ミラーについてはインストールガイドで説明しています。 方法は 1 つだけ選んでください。1 台のマシンに複数の方法でインストールすると、PATH の中で競合します。

クイックスタート

プロバイダーの API キーを一か所で管理。 Codewhale アカウントを作成するか、 codewhale login を実行してログインしてください。API キーをアカウントに保存・更新すると、 ログイン済みのデバイスから Codewhale のモデルルート経由で利用できます。 アカウントのキーを設定する。 ログインしても既存のローカルキーはアップロードされません。アカウントなしでもローカルで利用できます。

  1. プロジェクトを開く。 作業したいフォルダーで codewhale を実行します。
  2. モデルを接続する。 /provider（または F3）を実行して、ホスト型のキーを追加するか、ローカルランタイムを選びます。 チャットモデルを載せた Ollama がすでに起動していれば、Codewhale は自動的にそれへ切り替わります。モデルの変更は /model で行います。
  3. 具体的なタスクを渡す。
Fix the failing tests and explain what changed.

同じタスクを、スクリプトや CI ジョブからヘッドレスで実行することもできます。

codewhale exec --auto "fix the failing tests and explain what changed"

コマンドとキーボードショートカットは /help で確認できます。

実行方法

どのクライアントも同じローカルの Codewhale Runtime を操作するため、セッション、ツール、権限はどこでも同じように動作します。

コマンド 内容
codewhale 対話型のターミナルインターフェース
codewhale exec "…" スクリプトや CI からヘッドレスで 1 ターン実行します。--auto でファイルおよびシェルツールを許可し、--output-format stream-json で JSON をストリーミング出力します
codewhale web 127.0.0.1 で動作する、同梱のローカルブラウザークライアント
codewhale review --pr N 参考情報としてのプルリクエストレビュー。投稿は任意で有効化
Runtime API スレッド、イベント、承認のためのローカル HTTP API

ネイティブのデスクトップアプリ（GPUI）は、サインインして使う製品クライアントとして開発中です。提供状況は 製品ページをご覧ください。コミュニティが保守している VS Code 拡張機能は、 サイドバーから同じ Runtime に接続します（ソース）。

主な機能

  • どのモデルでも、ロックインなし。 Anthropic、DeepSeek、Google、Mistral、Moonshot、OpenAI、OpenRouter、xAI など、 40 以上のプロバイダー経路を内蔵。OpenAI 互換のエンドポイントや、Ollama、vLLM、SGLang 経由のローカルモデルも使えます。 プロバイダー
  • 主導権はあなたに。 Plan モードは何も変更せずに調査だけを行い、Work と Operate は変更を加えます。 承認ポスチャーがツール呼び出しにあなたの許可を求めるタイミングを決め、/undo と /restore でワークスペースの変更を元に戻せます。 /receipts はセッション内のすべてのファイル、コマンド、承認を一覧表示します。モード · レシート
  • 長い作業のために。 持続する /goal を設定し、範囲を区切った作業を サブエージェントに任せ、支出の事前チェック付きで監督される エージェントチームを動かし、あるいはリポジトリに含められる ワークフローとしてスクリプト化できます。
  • 普段使っているものを拡張。 MCP サーバーを接続し、 スキルとプラグインをインストールし、 セッションやツールのイベントでフックを実行し、既存の Claude Code プラグインも読み込めます。
  • Computer Use。 同梱のプラグインが、他のアプリケーションを観察・操作するツールを追加します。 使用前にアクセス範囲を確認し、有効化してください。 ガイド

モードと権限

切り替え方法 選択肢
モード（Mode）: エージェントが何をしているか Tab または /mode Plan（調査のみ、変更なし）· Work（編集と実行）· Operate（計画され検証されたステップで目標を進める）
ポスチャー（Posture）: いつ先に確認するか Shift+Tab Ask · Auto-Review · Full Access

Full Access でも、ハードなポリシー境界は守られます。 各選択肢についてはモードと権限のガイドで説明しています。

安全性

Codewhale はあなたのマシン上で、あなたが与えたアクセス権の範囲で動作します。承認ポスチャーとリポジトリのルールがエージェントにできることを制限し、 対応環境ではコマンドは OS のサンドボックス内で実行されます（macOS は Seatbelt、Linux では bubblewrap がインストールされ正常に動作する場合）。 /preview-request は、何かを送信する前に、機密情報を伏せたリクエストそのものを表示します。 価格が不明なモデルは「不明」のまま扱われ、無料として報告されることはありません。

認可の順序、 サンドボックス、テレメトリを参照してください。 利用回数の集計は既定で有効で、codewhale config set telemetry false で無効にできます。

ドキュメント

まずはここから さらに詳しく
インストール 設定
プロバイダーとローカルモデル アーキテクチャ
モードと権限 Runtime API
キーバインド プラグイン作成
GitHub PR レビュー すべてのドキュメント

コミュニティ

バグ報告、機能のアイデア、プルリクエストを歓迎します。Codewhale を何か月も使っている方も、初めて試す方も同じです。 プロバイダーが足りない、あるいはワークフローが使いにくいと感じたら、 issue を作成するか、 プルリクエストを送ってください。初めてのコントリビュートも歓迎で、 取り込まれた作業の貢献者としてのクレジットは保たれます。 リポジトリの構成が最初の手がかりになります。

Discord に参加するか、WeChat で Hunter （hunterbown）を追加して、Whale Brothers グループへの参加を依頼してください。

歴史とライセンス

Codewhale は deepseek-tui として始まり、今もそのプロジェクトの設定とセッションを読み込みます。 現在は特定のプロバイダーに依存せず、独立して保守されており、どのモデルプロバイダーとも提携していません。 すべてのコントリビューターと、成長を支えてくれたオープンソースコミュニティに感謝します。

MIT。他のオープンソースプロジェクトから改変して取り入れた部分は、 サードパーティ通知に記載しています。