| 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 | **L’agent de codi obert que funciona amb qualsevol model.** |
| 10 | |
| 11 | Codewhale llegeix el teu projecte, edita fitxers, executa ordres i comprova la seva |
| 12 | pròpia feina — al teu terminal, amb un model allotjat o local que tu tries. |
| 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 | [Lloc web](https://codewhale.net) · [Documentació](docs/README.md) · [Registre de canvis](CHANGELOG.md) · [Contribuir](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) · [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) |
| 23 | |
| 24 | <img src="web/public/codewhale-tui-8ba2bbf.png" alt="Una sessió de terminal de Codewhale" width="760"> |
| 25 | |
| 26 | <sub>Captura real del terminal en una instal·lació nova — sense sortida preparada.</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## Instal·lació |
| 31 | |
| 32 | macOS i Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | L’instal·lador descarrega binaris amb suma de verificació a `~/.local/bin`. Si |
| 39 | després `codewhale` respon "command not found", executa l’única línia de PATH que |
| 40 | mostra l’instal·lador, o consulta [Afegir-lo al PATH](docs/INSTALL.md#put-it-on-your-path). |
| 41 | Actualitza quan vulguis amb `codewhale update`. |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows, npm, Cargo i altres vies</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 a Linux, Android/Termux, les descàrregues manuals amb |
| 53 | verificació de la suma de control i el mirall opcional de CNB s’expliquen a la |
| 54 | [guia d’instal·lació](docs/INSTALL.md). Tria una sola via: diverses |
| 55 | instal·lacions a la mateixa màquina acaben disputant-se el `PATH`. |
| 56 | |
| 57 | </details> |
| 58 | |
| 59 | ## Inici ràpid |
| 60 | |
| 61 | 1. **Obre el teu projecte.** Executa `codewhale` a la carpeta on vols treballar. |
| 62 | 2. **Connecta un model.** Executa `/provider` (o prem `F3`) per afegir una clau |
| 63 | allotjada o triar un entorn local. Si Ollama ja s’està executant amb un model |
| 64 | de xat, Codewhale hi canvia per si sol. Fes servir `/model` per canviar de model. |
| 65 | 3. **Dona-li una tasca concreta.** |
| 66 | |
| 67 | ```text |
| 68 | Fix the failing tests and explain what changed. |
| 69 | ``` |
| 70 | |
| 71 | La mateixa tasca es pot executar sense interfície des d’un script o una tasca de CI: |
| 72 | |
| 73 | ```bash |
| 74 | codewhale exec "fix the failing tests and explain what changed" |
| 75 | ``` |
| 76 | |
| 77 | Executa `/help` per veure les ordres i les dreceres de teclat. |
| 78 | |
| 79 | ## Maneres d’executar-lo |
| 80 | |
| 81 | Tots els clients fan servir el mateix Runtime local de Codewhale, de manera que |
| 82 | les sessions, les eines i els permisos es comporten igual a tot arreu. |
| 83 | |
| 84 | | Ordre | Què fa | |
| 85 | | --- | --- | |
| 86 | | `codewhale` | La interfície interactiva de terminal | |
| 87 | | `codewhale exec "…"` | Un torn sense interfície des d’un script o CI, amb sortida JSON en streaming | |
| 88 | | `codewhale web` | El [client de navegador local](docs/WEB.md) inclòs, a `127.0.0.1` | |
| 89 | | `codewhale review --pr N` | Una [revisió de pull request](docs/GITHUB_ACTION.md) merament orientativa; publicar-la és opcional | |
| 90 | | Runtime API | Una [API HTTP local](docs/RUNTIME_API.md) per a fils, esdeveniments i aprovacions | |
| 91 | |
| 92 | S’està desenvolupant una aplicació d’escriptori nativa (GPUI) com a client del |
| 93 | producte amb sessió iniciada; consulta la |
| 94 | [pàgina del producte](https://codewhale.net/en/product) per veure’n la disponibilitat. L’[extensió de VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode), |
| 95 | mantinguda per la comunitat, es connecta al mateix Runtime des d’una barra lateral |
| 96 | ([codi font](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 97 | |
| 98 | ## Què fa |
| 99 | |
| 100 | - **Qualsevol model, sense dependència d’un proveïdor.** Més de 40 rutes de |
| 101 | proveïdors integrades — Anthropic, DeepSeek, Google, Mistral, Moonshot, |
| 102 | OpenAI, OpenRouter, xAI i més — a més de qualsevol endpoint compatible amb |
| 103 | OpenAI i models locals mitjançant Ollama, vLLM o SGLang. [Proveïdors](docs/PROVIDERS.md) |
| 104 | - **Tu mantens el control.** El mode Plan explora sense canviar res; Work i |
| 105 | Operate fan canvis. Les postures d’aprovació decideixen quan una crida a una |
| 106 | eina necessita el teu vistiplau, `/undo` i `/restore` recuperen els canvis de |
| 107 | l’espai de treball, i `/receipts` enumera cada fitxer, ordre i aprovació d’una |
| 108 | sessió. [Modes](docs/MODES.md) · [Rebuts](docs/RECEIPTS.md) |
| 109 | - **Pensat per a feines llargues.** Defineix un `/goal` durador, delega feina |
| 110 | acotada a [subagents](docs/SUBAGENTS.md), executa [equips d’agents](docs/FLEET.md) |
| 111 | supervisats amb una comprovació prèvia de la despesa, o automatitza’ls com a |
| 112 | [fluxos de treball](docs/WORKFLOW_AUTHORING.md) versionats al repositori. |
| 113 | - **Amplia el que ja fas servir.** Connecta [servidors MCP](docs/MCP.md), |
| 114 | instal·la [skills](docs/SKILLS.md) i [plugins](docs/PLUGINS.md), executa |
| 115 | [hooks](docs/HOOKS.md) en esdeveniments de sessió i d’eines, i carrega els |
| 116 | [plugins de Claude Code](docs/CLAUDE_PLUGIN_COMPAT.md) existents. |
| 117 | - **Computer Use.** Un plugin inclòs afegeix eines per observar i operar altres |
| 118 | aplicacions. Revisa l’accés que sol·licita i habilita’l abans de fer-lo servir. |
| 119 | [Guia](crates/tui/plugins/computer-use/README.md) |
| 120 | |
| 121 | ## Modes i permisos |
| 122 | |
| 123 | | | Es tria amb | Opcions | |
| 124 | | --- | --- | --- | |
| 125 | | **Mode** — el que fa l’agent | `Tab` o `/mode` | Plan (explorar, sense canvis) · Work (editar i executar) · Operate (portar un objectiu endavant amb passos planificats i verificats) | |
| 126 | | **Postura** — quan pregunta abans | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 127 | |
| 128 | Full Access continua respectant els límits estrictes de les polítiques. La |
| 129 | [guia de modes i permisos](docs/MODES.md) explica cada opció. |
| 130 | |
| 131 | ## Seguretat |
| 132 | |
| 133 | Codewhale s’executa al teu equip amb l’accés que li concedeixis. Les postures |
| 134 | d’aprovació i les regles del repositori limiten el que l’agent pot fer, i les |
| 135 | ordres s’executen dins d’un sandbox del sistema operatiu on és compatible |
| 136 | (Seatbelt a macOS; bubblewrap a Linux és opcional). `/preview-request` mostra la |
| 137 | sol·licitud exacta, amb les dades sensibles ocultades, abans d’enviar res. Els |
| 138 | preus de models desconeguts continuen sent desconeguts en lloc de presentar-se |
| 139 | com a gratuïts. |
| 140 | |
| 141 | Consulta l’[ordre d’autorització](docs/AUTHORIZATION_ORDER.md), el |
| 142 | [sandboxing](docs/SANDBOX.md) i la [telemetria](docs/TELEMETRY.md): els |
| 143 | comptadors d’ús estan activats per defecte i `codewhale config set telemetry false` |
| 144 | els desactiva. |
| 145 | |
| 146 | ## Documentació |
| 147 | |
| 148 | | Comença aquí | Aprofundeix | |
| 149 | | --- | --- | |
| 150 | | [Instal·lació](docs/INSTALL.md) | [Configuració](docs/CONFIGURATION.md) | |
| 151 | | [Proveïdors i models locals](docs/PROVIDERS.md) | [Arquitectura](docs/ARCHITECTURE.md) | |
| 152 | | [Modes i permisos](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 153 | | [Dreceres de teclat](docs/KEYBINDINGS.md) | [Creació de plugins](docs/PLUGIN_AUTHORING.md) | |
| 154 | | [Revisió de PR a GitHub](docs/GITHUB_ACTION.md) | [Tota la documentació](docs/README.md) | |
| 155 | |
| 156 | ## Comunitat |
| 157 | |
| 158 | Els informes d’errors, les idees de funcionalitats i els pull requests són |
| 159 | benvinguts, tant si fa mesos que fas servir Codewhale com si el proves per |
| 160 | primera vegada. Si falta un proveïdor o un flux de treball resulta incòmode, |
| 161 | [obre un issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) o |
| 162 | [envia un pull request](CONTRIBUTING.md). Les primeres contribucions són |
| 163 | benvingudes, i qui contribueix conserva el crèdit pel treball que s’hi integra. |
| 164 | L’[estructura del repositori](CONTRIBUTING.md#project-structure) és un bon punt |
| 165 | de partida. |
| 166 | |
| 167 | Uneix-te al [Discord](https://discord.gg/37gfS3ksug), o afegeix Hunter a WeChat |
| 168 | (`hunterbown`) i demana entrar al grup Whale Brothers. |
| 169 | |
| 170 | ## Història i llicència |
| 171 | |
| 172 | Codewhale va començar com a `deepseek-tui` i encara llegeix la configuració i les |
| 173 | sessions d’aquest projecte. Ara és neutral respecte dels proveïdors, es manté de |
| 174 | manera independent i no està afiliat a cap proveïdor de models. Gràcies a |
| 175 | [tots els col·laboradors](docs/CONTRIBUTORS.md) i a les comunitats de codi obert |
| 176 | que han ajudat que creixi. |
| 177 | |
| 178 | [MIT](LICENSE). Les parts adaptades d’altres projectes de codi obert es recullen |
| 179 | als [avisos de tercers](docs/THIRD_PARTY_NOTICES.md). |
| 180 |