| 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 | **El agente de código abierto que funciona con cualquier modelo.** |
| 10 | |
| 11 | Codewhale lee tu proyecto, edita archivos, ejecuta comandos y comprueba su propio |
| 12 | trabajo — en tu terminal, con un modelo alojado o local que tú eliges. |
| 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 | [Sitio web](https://codewhale.net) · [Documentación](docs/README.md) · [Registro de cambios](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) · [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="Una sesión de terminal de Codewhale" width="760"> |
| 25 | |
| 26 | <sub>Captura real de la terminal en una instalación nueva — sin salida preparada.</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## Instalación |
| 31 | |
| 32 | macOS y Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | El instalador descarga binarios con suma de verificación en `~/.local/bin`. Si |
| 39 | después `codewhale` responde "command not found", ejecuta la única línea de PATH |
| 40 | que muestra el instalador, o consulta [Agregarlo al PATH](docs/INSTALL.md#put-it-on-your-path). |
| 41 | Actualiza cuando quieras con `codewhale update`. |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows, npm, Cargo y otras vías</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 en Linux, Android/Termux, las descargas manuales con |
| 53 | verificación de suma de control y el espejo opcional de CNB se explican en la |
| 54 | [guía de instalación](docs/INSTALL.md). Elige una sola vía: varias instalaciones |
| 55 | en la misma máquina terminan disputándose el `PATH`. |
| 56 | |
| 57 | </details> |
| 58 | |
| 59 | ## Inicio rápido |
| 60 | |
| 61 | 1. **Abre tu proyecto.** Ejecuta `codewhale` en la carpeta en la que quieres trabajar. |
| 62 | 2. **Conecta un modelo.** Ejecuta `/provider` (o presiona `F3`) para agregar una |
| 63 | clave alojada o elegir un entorno local. Si Ollama ya se está ejecutando con |
| 64 | un modelo de chat, Codewhale cambia a él por sí solo. Usa `/model` para cambiar de modelo. |
| 65 | 3. **Dale una tarea concreta.** |
| 66 | |
| 67 | ```text |
| 68 | Fix the failing tests and explain what changed. |
| 69 | ``` |
| 70 | |
| 71 | La misma tarea se puede ejecutar sin interfaz desde un script o un trabajo de CI: |
| 72 | |
| 73 | ```bash |
| 74 | codewhale exec "fix the failing tests and explain what changed" |
| 75 | ``` |
| 76 | |
| 77 | Ejecuta `/help` para ver los comandos y los atajos de teclado. |
| 78 | |
| 79 | ## Formas de ejecutarlo |
| 80 | |
| 81 | Todos los clientes usan el mismo Runtime local de Codewhale, así que las sesiones, |
| 82 | las herramientas y los permisos se comportan igual en todas partes. |
| 83 | |
| 84 | | Comando | Qué hace | |
| 85 | | --- | --- | |
| 86 | | `codewhale` | La interfaz interactiva de terminal | |
| 87 | | `codewhale exec "…"` | Un turno sin interfaz desde un script o CI, con salida JSON en streaming | |
| 88 | | `codewhale web` | El [cliente de navegador local](docs/WEB.md) incluido, en `127.0.0.1` | |
| 89 | | `codewhale review --pr N` | Una [revisión de pull request](docs/GITHUB_ACTION.md) de carácter orientativo; publicarla es opcional | |
| 90 | | Runtime API | Una [API HTTP local](docs/RUNTIME_API.md) para hilos, eventos y aprobaciones | |
| 91 | |
| 92 | Se está desarrollando una aplicación de escritorio nativa (GPUI) como cliente del |
| 93 | producto con sesión iniciada; consulta la |
| 94 | [página del producto](https://codewhale.net/en/product) para ver su disponibilidad. La |
| 95 | [extensión de VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode), |
| 96 | mantenida por la comunidad, se conecta al mismo Runtime desde una barra lateral |
| 97 | ([código fuente](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 98 | |
| 99 | ## Qué hace |
| 100 | |
| 101 | - **Cualquier modelo, sin dependencia de un proveedor.** Más de 40 rutas de |
| 102 | proveedores integradas — Anthropic, DeepSeek, Google, Mistral, Moonshot, |
| 103 | OpenAI, OpenRouter, xAI y más — además de cualquier endpoint compatible con |
| 104 | OpenAI y modelos locales mediante Ollama, vLLM o SGLang. [Proveedores](docs/PROVIDERS.md) |
| 105 | - **Tú mantienes el control.** El modo Plan explora sin cambiar nada; Work y |
| 106 | Operate hacen cambios. Las posturas de aprobación deciden cuándo una llamada a |
| 107 | una herramienta necesita tu visto bueno, `/undo` y `/restore` recuperan los |
| 108 | cambios del espacio de trabajo, y `/receipts` enumera cada archivo, comando y |
| 109 | aprobación de una sesión. [Modos](docs/MODES.md) · |
| 110 | [Recibos](docs/RECEIPTS.md) |
| 111 | - **Pensado para trabajos largos.** Define un `/goal` duradero, delega trabajo |
| 112 | acotado a [sub-agentes](docs/SUBAGENTS.md), ejecuta [equipos de agentes](docs/FLEET.md) |
| 113 | supervisados con una verificación previa del gasto, o automatízalos como |
| 114 | [flujos de trabajo](docs/WORKFLOW_AUTHORING.md) versionados en el repositorio. |
| 115 | - **Amplía lo que ya usas.** Conecta [servidores MCP](docs/MCP.md), instala |
| 116 | [skills](docs/SKILLS.md) y [plugins](docs/PLUGINS.md), ejecuta |
| 117 | [hooks](docs/HOOKS.md) en eventos de sesión y de herramientas, y carga los |
| 118 | [plugins de Claude Code](docs/CLAUDE_PLUGIN_COMPAT.md) existentes. |
| 119 | - **Computer Use.** Un plugin incluido agrega herramientas para observar y |
| 120 | operar otras aplicaciones. Revisa el acceso que solicita y habilítalo antes de usarlo. |
| 121 | [Guía](crates/tui/plugins/computer-use/README.md) |
| 122 | |
| 123 | ## Modos y permisos |
| 124 | |
| 125 | | | Se elige con | Opciones | |
| 126 | | --- | --- | --- | |
| 127 | | **Modo** — lo que hace el agente | `Tab` o `/mode` | Plan (explorar, sin cambios) · Work (editar y ejecutar) · Operate (llevar un objetivo adelante con pasos planificados y verificados) | |
| 128 | | **Postura** — cuándo pregunta antes | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 129 | |
| 130 | Full Access sigue respetando los límites estrictos de las políticas. La |
| 131 | [guía de modos y permisos](docs/MODES.md) explica cada opción. |
| 132 | |
| 133 | ## Seguridad |
| 134 | |
| 135 | Codewhale se ejecuta en tu equipo con el acceso que le otorgues. Las posturas de |
| 136 | aprobación y las reglas del repositorio limitan lo que el agente puede hacer, y |
| 137 | los comandos se ejecutan dentro de un sandbox del sistema operativo donde es |
| 138 | compatible (Seatbelt en macOS; bubblewrap en Linux es opcional). |
| 139 | `/preview-request` muestra la solicitud exacta, con los datos sensibles |
| 140 | redactados, antes de enviar nada. Los precios de modelos desconocidos siguen |
| 141 | siendo desconocidos en lugar de presentarse como gratuitos. |
| 142 | |
| 143 | Consulta el [orden de autorización](docs/AUTHORIZATION_ORDER.md), el |
| 144 | [sandboxing](docs/SANDBOX.md) y la [telemetría](docs/TELEMETRY.md): los |
| 145 | contadores de uso están activados por defecto y `codewhale config set telemetry false` |
| 146 | los desactiva. |
| 147 | |
| 148 | ## Documentación |
| 149 | |
| 150 | | Empieza aquí | Profundiza | |
| 151 | | --- | --- | |
| 152 | | [Instalación](docs/INSTALL.md) | [Configuración](docs/CONFIGURATION.md) | |
| 153 | | [Proveedores y modelos locales](docs/PROVIDERS.md) | [Arquitectura](docs/ARCHITECTURE.md) | |
| 154 | | [Modos y permisos](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 155 | | [Atajos de teclado](docs/KEYBINDINGS.md) | [Creación de plugins](docs/PLUGIN_AUTHORING.md) | |
| 156 | | [Revisión de PR en GitHub](docs/GITHUB_ACTION.md) | [Toda la documentación](docs/README.md) | |
| 157 | |
| 158 | ## Comunidad |
| 159 | |
| 160 | Los reportes de errores, las ideas de funciones y los pull requests son |
| 161 | bienvenidos, ya uses Codewhale desde hace meses o lo pruebes por primera vez. Si |
| 162 | falta un proveedor o un flujo de trabajo resulta incómodo, |
| 163 | [abre un issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) o |
| 164 | [envía un pull request](CONTRIBUTING.md). Las primeras contribuciones son |
| 165 | bienvenidas, y quienes contribuyen conservan el crédito por el trabajo que se |
| 166 | integra. La [estructura del repositorio](CONTRIBUTING.md#project-structure) es un |
| 167 | buen punto de partida. |
| 168 | |
| 169 | Únete a [Discord](https://discord.gg/37gfS3ksug), o agrega a Hunter en WeChat |
| 170 | (`hunterbown`) y pide entrar al grupo Whale Brothers. |
| 171 | |
| 172 | ## Historia y licencia |
| 173 | |
| 174 | Codewhale comenzó como `deepseek-tui` y todavía lee la configuración y las |
| 175 | sesiones de ese proyecto. Ahora es neutral respecto de los proveedores, se |
| 176 | mantiene de forma independiente y no está afiliado a ningún proveedor de |
| 177 | modelos. Gracias a [cada colaborador](docs/CONTRIBUTORS.md) y a las comunidades |
| 178 | de código abierto que ayudaron a que crezca. |
| 179 | |
| 180 | [MIT](LICENSE). Las partes adaptadas de otros proyectos de código abierto se |
| 181 | registran en los [avisos de terceros](docs/THIRD_PARTY_NOTICES.md). |
| 182 |