| 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 | **Der Open-Source-Coding-Agent, der mit jedem Modell arbeitet.** |
| 10 | |
| 11 | Codewhale liest dein Projekt, bearbeitet Dateien, führt Befehle aus und prüft seine eigene |
| 12 | Arbeit — in deinem Terminal, mit einem gehosteten oder lokalen Modell deiner Wahl. |
| 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 | [Website](https://codewhale.net) · [Dokumentation](docs/README.md) · [Changelog](CHANGELOG.md) · [Mitwirken](CONTRIBUTING.md) |
| 21 | |
| 22 | [English](README.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja-JP.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) · [繁體中文](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="Eine Codewhale-Terminalsitzung" width="760"> |
| 25 | |
| 26 | <sub>Echte Terminalaufnahme einer frischen Installation — keine inszenierte Ausgabe.</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## Installation |
| 31 | |
| 32 | macOS und Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | Das Installationsskript lädt Binärdateien mit geprüfter Prüfsumme nach `~/.local/bin`. Meldet |
| 39 | `codewhale` danach „command not found“, führe die eine PATH-Zeile aus, die das Skript ausgibt, |
| 40 | oder siehe [Zum PATH hinzufügen](docs/INSTALL.md#put-it-on-your-path). |
| 41 | Aktualisieren kannst du jederzeit mit `codewhale update`. |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows, npm, Cargo und weitere Wege</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, Homebrew unter Linux, Android/Termux, manuelle Downloads mit Prüfsummenkontrolle |
| 53 | und der optionale CNB-Mirror sind in der |
| 54 | [Installationsanleitung](docs/INSTALL.md) beschrieben. Wähle einen Weg: Mehrere Installationen |
| 55 | auf einem Rechner streiten sich am Ende um den `PATH`. |
| 56 | |
| 57 | </details> |
| 58 | |
| 59 | ## Schnellstart |
| 60 | |
| 61 | 1. **Öffne dein Projekt.** Starte `codewhale` in dem Ordner, an dem du arbeiten willst. |
| 62 | 2. **Verbinde ein Modell.** Starte `/provider` (oder drücke `F3`), um einen gehosteten Schlüssel |
| 63 | hinzuzufügen oder eine lokale Runtime zu wählen. Läuft Ollama bereits mit einem Chat-Modell, |
| 64 | wechselt Codewhale von selbst dorthin. Mit `/model` wechselst du das Modell. |
| 65 | 3. **Gib ihm eine konkrete Aufgabe.** |
| 66 | |
| 67 | ```text |
| 68 | Fix the failing tests and explain what changed. |
| 69 | ``` |
| 70 | |
| 71 | Dieselbe Aufgabe läuft ohne Oberfläche aus einem Skript oder CI-Job: |
| 72 | |
| 73 | ```bash |
| 74 | codewhale exec "fix the failing tests and explain what changed" |
| 75 | ``` |
| 76 | |
| 77 | Mit `/help` siehst du Befehle und Tastenkürzel. |
| 78 | |
| 79 | ## Wege, es auszuführen |
| 80 | |
| 81 | Jeder Client steuert dieselbe lokale Codewhale Runtime, daher verhalten sich Sitzungen, Tools |
| 82 | und Berechtigungen überall gleich. |
| 83 | |
| 84 | | Befehl | Was er tut | |
| 85 | | --- | --- | |
| 86 | | `codewhale` | Die interaktive Terminaloberfläche | |
| 87 | | `codewhale exec "…"` | Ein Durchlauf ohne Oberfläche aus einem Skript oder der CI, mit JSON-Streaming | |
| 88 | | `codewhale web` | Der mitgelieferte [lokale Browser-Client](docs/WEB.md) auf `127.0.0.1` | |
| 89 | | `codewhale review --pr N` | Ein beratendes [Pull-Request-Review](docs/GITHUB_ACTION.md); das Veröffentlichen ist optional | |
| 90 | | Runtime API | Eine [lokale HTTP-API](docs/RUNTIME_API.md) für Threads, Ereignisse und Freigaben | |
| 91 | |
| 92 | Eine native Desktop-App (GPUI) wird als Produkt-Client für angemeldete Nutzer entwickelt; |
| 93 | Informationen zur Verfügbarkeit findest du auf der |
| 94 | [Produktseite](https://codewhale.net/en/product). Die von der Community gepflegte |
| 95 | [VS Code-Erweiterung](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode) |
| 96 | verbindet sich aus einer Seitenleiste mit derselben Runtime ([Quellcode](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 97 | |
| 98 | ## Was es kann |
| 99 | |
| 100 | - **Jedes Modell, ohne Lock-in.** Über 40 eingebaute Anbieter-Routen — Anthropic, DeepSeek, |
| 101 | Google, Mistral, Moonshot, OpenAI, OpenRouter, xAI und weitere — dazu jeder |
| 102 | OpenAI-kompatible Endpunkt und lokale Modelle über Ollama, vLLM oder SGLang. |
| 103 | [Anbieter](docs/PROVIDERS.md) |
| 104 | - **Du behältst die Kontrolle.** Der Plan-Modus erkundet, ohne etwas zu ändern; Work und Operate |
| 105 | nehmen Änderungen vor. Freigabe-Haltungen entscheiden, wann ein Tool-Aufruf deine Zustimmung |
| 106 | braucht, `/undo` und `/restore` stellen Änderungen im Arbeitsbereich wieder her, und |
| 107 | `/receipts` listet jede Datei, jeden Befehl und jede Freigabe einer Sitzung auf. |
| 108 | [Modi](docs/MODES.md) · [Belege](docs/RECEIPTS.md) |
| 109 | - **Gebaut für lange Aufgaben.** Setze ein dauerhaftes `/goal`, delegiere abgegrenzte Arbeit an |
| 110 | [Sub-Agenten](docs/SUBAGENTS.md), betreibe beaufsichtigte [Agententeams](docs/FLEET.md) mit |
| 111 | einer Prüfung vor dem Ausgeben, oder skripte sie als eingecheckte |
| 112 | [Workflows](docs/WORKFLOW_AUTHORING.md). |
| 113 | - **Erweitere, was du schon nutzt.** Verbinde [MCP-Server](docs/MCP.md), installiere |
| 114 | [Skills](docs/SKILLS.md) und [Plugins](docs/PLUGINS.md), führe |
| 115 | [Hooks](docs/HOOKS.md) bei Sitzungs- und Tool-Ereignissen aus und lade vorhandene |
| 116 | [Claude-Code-Plugins](docs/CLAUDE_PLUGIN_COMPAT.md). |
| 117 | - **Computer Use.** Ein mitgeliefertes Plugin fügt Tools zum Beobachten und Bedienen anderer |
| 118 | Anwendungen hinzu. Prüfe seine Zugriffsrechte und aktiviere es vor der Nutzung. |
| 119 | [Anleitung](crates/tui/plugins/computer-use/README.md) |
| 120 | |
| 121 | ## Modi und Berechtigungen |
| 122 | |
| 123 | | | Auswahl mit | Optionen | |
| 124 | | --- | --- | --- | |
| 125 | | **Modus** — was der Agent gerade tut | `Tab` oder `/mode` | Plan (erkunden, keine Änderungen) · Work (bearbeiten und ausführen) · Operate (ein Ziel über geplante, geprüfte Schritte verfolgen) | |
| 126 | | **Haltung** — wann er vorher fragt | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 127 | |
| 128 | Full Access respektiert weiterhin die harten Richtliniengrenzen. Die |
| 129 | [Anleitung zu Modi und Berechtigungen](docs/MODES.md) erklärt jede Option. |
| 130 | |
| 131 | ## Sicherheit |
| 132 | |
| 133 | Codewhale läuft auf deinem Rechner mit den Zugriffsrechten, die du ihm gibst. Freigabe-Haltungen |
| 134 | und Repository-Regeln begrenzen, was der Agent tun darf, und Befehle laufen, wo unterstützt, in |
| 135 | einer Betriebssystem-Sandbox (Seatbelt unter macOS; bubblewrap unter Linux ist optional). |
| 136 | `/preview-request` zeigt die exakte, geschwärzte Anfrage, bevor etwas gesendet wird. |
| 137 | Unbekannte Modellpreise bleiben unbekannt, statt als kostenlos ausgewiesen zu werden. |
| 138 | |
| 139 | Siehe [Autorisierungsreihenfolge](docs/AUTHORIZATION_ORDER.md), |
| 140 | [Sandboxing](docs/SANDBOX.md) und [Telemetrie](docs/TELEMETRY.md) — Nutzungszähler sind |
| 141 | standardmäßig aktiv, und `codewhale config set telemetry false` schaltet sie ab. |
| 142 | |
| 143 | ## Dokumentation |
| 144 | |
| 145 | | Zum Einstieg | Zum Vertiefen | |
| 146 | | --- | --- | |
| 147 | | [Installation](docs/INSTALL.md) | [Konfiguration](docs/CONFIGURATION.md) | |
| 148 | | [Anbieter und lokale Modelle](docs/PROVIDERS.md) | [Architektur](docs/ARCHITECTURE.md) | |
| 149 | | [Modi und Berechtigungen](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 150 | | [Tastenbelegung](docs/KEYBINDINGS.md) | [Plugins entwickeln](docs/PLUGIN_AUTHORING.md) | |
| 151 | | [GitHub-PR-Review](docs/GITHUB_ACTION.md) | [Gesamte Dokumentation](docs/README.md) | |
| 152 | |
| 153 | ## Community |
| 154 | |
| 155 | Fehlerberichte, Funktionsideen und Pull Requests sind willkommen — ob du Codewhale seit Monaten |
| 156 | nutzt oder es zum ersten Mal ausprobierst. Fehlt ein Anbieter oder ist ein Workflow |
| 157 | umständlich, [eröffne ein Issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) oder |
| 158 | [sende einen Pull Request](CONTRIBUTING.md). Erste Beiträge sind willkommen, und wer beiträgt, |
| 159 | behält die Anerkennung für die übernommene Arbeit. Die |
| 160 | [Repository-Struktur](CONTRIBUTING.md#project-structure) ist ein guter Einstieg. |
| 161 | |
| 162 | Tritt dem [Discord](https://discord.gg/37gfS3ksug) bei, oder füge Hunter auf WeChat |
| 163 | (`hunterbown`) hinzu und bitte darum, in die Gruppe Whale Brothers aufgenommen zu werden. |
| 164 | |
| 165 | ## Geschichte und Lizenz |
| 166 | |
| 167 | Codewhale begann als `deepseek-tui` und liest weiterhin die Konfiguration und die Sitzungen |
| 168 | dieses Projekts. Es ist inzwischen anbieterneutral, wird unabhängig gepflegt und ist mit keinem |
| 169 | Modellanbieter verbunden. Danke an |
| 170 | [alle Mitwirkenden](docs/CONTRIBUTORS.md) und an die Open-Source-Communities, die zu seinem |
| 171 | Wachstum beigetragen haben. |
| 172 | |
| 173 | [MIT](LICENSE). Aus anderen Open-Source-Projekten übernommene Teile sind in den |
| 174 | [Hinweisen zu Drittanbietern](docs/THIRD_PARTY_NOTICES.md) verzeichnet. |
| 175 |