| 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 | **O agente de código aberto que funciona com qualquer modelo.** |
| 10 | |
| 11 | O Codewhale lê seu projeto, edita arquivos, executa comandos e verifica o próprio |
| 12 | trabalho — no seu terminal, com um modelo hospedado ou local à sua escolha. |
| 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 | [Site](https://codewhale.net) · [Documentação](docs/README.md) · [Changelog](CHANGELOG.md) · [Contribuindo](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) · [Русский](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="Uma sessão de terminal do Codewhale" width="760"> |
| 25 | |
| 26 | <sub>Captura real do terminal em uma instalação nova — sem saída encenada.</sub> |
| 27 | |
| 28 | </div> |
| 29 | |
| 30 | ## Instalação |
| 31 | |
| 32 | macOS e Linux: |
| 33 | |
| 34 | ```bash |
| 35 | curl -fsSL https://codewhale.net/install.sh | sh |
| 36 | ``` |
| 37 | |
| 38 | O instalador baixa binários com checksum verificado para `~/.local/bin`. Se |
| 39 | depois `codewhale` responder "command not found", execute a única linha de PATH |
| 40 | que o instalador exibe, ou veja [Colocar no PATH](docs/INSTALL.md#put-it-on-your-path). |
| 41 | Atualize quando quiser com `codewhale update`. |
| 42 | |
| 43 | <details> |
| 44 | <summary><b>Windows, npm, Cargo e outras formas</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 no Linux, Android/Termux, downloads manuais com |
| 53 | verificação de checksum e o espelho opcional do CNB estão descritos no |
| 54 | [guia de instalação](docs/INSTALL.md). Escolha uma única forma: várias |
| 55 | instalações na mesma máquina acabam disputando o `PATH`. |
| 56 | |
| 57 | </details> |
| 58 | |
| 59 | ## Início rápido |
| 60 | |
| 61 | 1. **Abra seu projeto.** Execute `codewhale` na pasta em que quer trabalhar. |
| 62 | 2. **Conecte um modelo.** Execute `/provider` (ou pressione `F3`) para adicionar |
| 63 | uma chave hospedada ou escolher um ambiente local. Se o Ollama já estiver em |
| 64 | execução com um modelo de chat, o Codewhale passa a usá-lo sozinho. Use |
| 65 | `/model` para trocar de modelo. |
| 66 | 3. **Dê a ele uma tarefa concreta.** |
| 67 | |
| 68 | ```text |
| 69 | Fix the failing tests and explain what changed. |
| 70 | ``` |
| 71 | |
| 72 | A mesma tarefa pode rodar sem interface, a partir de um script ou job de CI: |
| 73 | |
| 74 | ```bash |
| 75 | codewhale exec "fix the failing tests and explain what changed" |
| 76 | ``` |
| 77 | |
| 78 | Execute `/help` para ver os comandos e atalhos de teclado. |
| 79 | |
| 80 | ## Formas de executar |
| 81 | |
| 82 | Todos os clientes usam o mesmo Runtime local do Codewhale, então sessões, |
| 83 | ferramentas e permissões se comportam da mesma forma em qualquer lugar. |
| 84 | |
| 85 | | Comando | O que faz | |
| 86 | | --- | --- | |
| 87 | | `codewhale` | A interface interativa de terminal | |
| 88 | | `codewhale exec "…"` | Um turno sem interface, a partir de um script ou CI, com saída JSON em streaming | |
| 89 | | `codewhale web` | O [cliente de navegador local](docs/WEB.md) incluído, em `127.0.0.1` | |
| 90 | | `codewhale review --pr N` | Uma [revisão de pull request](docs/GITHUB_ACTION.md) apenas consultiva; publicá-la é opcional | |
| 91 | | Runtime API | Uma [API HTTP local](docs/RUNTIME_API.md) para threads, eventos e aprovações | |
| 92 | |
| 93 | Um aplicativo desktop nativo (GPUI) está sendo desenvolvido como cliente do |
| 94 | produto com login; veja a |
| 95 | [página do produto](https://codewhale.net/en/product) para saber a disponibilidade. A |
| 96 | [extensão do VS Code](https://marketplace.visualstudio.com/items?itemName=HengQuWorld.brotherwhale-vscode), |
| 97 | mantida pela comunidade, conecta-se ao mesmo Runtime a partir de uma barra |
| 98 | lateral ([código-fonte](https://github.com/HengQuWorld/CodeWhale-VSCode)). |
| 99 | |
| 100 | ## O que ele faz |
| 101 | |
| 102 | - **Qualquer modelo, sem dependência de fornecedor.** Mais de 40 rotas de |
| 103 | provedores integradas — Anthropic, DeepSeek, Google, Mistral, Moonshot, |
| 104 | OpenAI, OpenRouter, xAI e outros — além de qualquer endpoint compatível com |
| 105 | OpenAI e modelos locais via Ollama, vLLM ou SGLang. [Provedores](docs/PROVIDERS.md) |
| 106 | - **Você mantém o controle.** O modo Plan explora sem alterar nada; Work e |
| 107 | Operate fazem alterações. As posturas de aprovação definem quando uma chamada |
| 108 | de ferramenta precisa do seu OK, `/undo` e `/restore` recuperam alterações do |
| 109 | workspace, e `/receipts` lista cada arquivo, comando e aprovação de uma |
| 110 | sessão. [Modos](docs/MODES.md) · [Recibos](docs/RECEIPTS.md) |
| 111 | - **Feito para trabalhos longos.** Defina um `/goal` durável, delegue trabalho |
| 112 | delimitado a [sub-agentes](docs/SUBAGENTS.md), execute [equipes de agentes](docs/FLEET.md) |
| 113 | supervisionadas com uma checagem prévia de gastos, ou automatize-as como |
| 114 | [workflows](docs/WORKFLOW_AUTHORING.md) versionados no repositório. |
| 115 | - **Amplie o que você já usa.** Conecte [servidores MCP](docs/MCP.md), instale |
| 116 | [skills](docs/SKILLS.md) e [plugins](docs/PLUGINS.md), execute |
| 117 | [hooks](docs/HOOKS.md) em eventos de sessão e de ferramentas, e carregue os |
| 118 | [plugins do Claude Code](docs/CLAUDE_PLUGIN_COMPAT.md) existentes. |
| 119 | - **Computer Use.** Um plugin incluído adiciona ferramentas para observar e |
| 120 | operar outros aplicativos. Revise o acesso que ele solicita e ative-o antes de usar. |
| 121 | [Guia](crates/tui/plugins/computer-use/README.md) |
| 122 | |
| 123 | ## Modos e permissões |
| 124 | |
| 125 | | | Escolha com | Opções | |
| 126 | | --- | --- | --- | |
| 127 | | **Modo** — o que o agente está fazendo | `Tab` ou `/mode` | Plan (explorar, sem alterações) · Work (editar e executar) · Operate (conduzir um objetivo com etapas planejadas e verificadas) | |
| 128 | | **Postura** — quando ele pergunta antes | `Shift+Tab` | Ask · Auto-Review · Full Access | |
| 129 | |
| 130 | O Full Access continua respeitando os limites rígidos de política. O |
| 131 | [guia de modos e permissões](docs/MODES.md) explica cada opção. |
| 132 | |
| 133 | ## Segurança |
| 134 | |
| 135 | O Codewhale roda na sua máquina com o acesso que você conceder. As posturas de |
| 136 | aprovação e as regras do repositório limitam o que o agente pode fazer, e os |
| 137 | comandos rodam dentro de um sandbox do sistema operacional onde há suporte |
| 138 | (Seatbelt no macOS; bubblewrap no Linux é opcional). |
| 139 | `/preview-request` mostra a requisição exata, com dados sensíveis ocultados, |
| 140 | antes de qualquer envio. Preços de modelos desconhecidos continuam |
| 141 | desconhecidos, em vez de serem apresentados como gratuitos. |
| 142 | |
| 143 | Veja a [ordem de autorização](docs/AUTHORIZATION_ORDER.md), o |
| 144 | [sandboxing](docs/SANDBOX.md) e a [telemetria](docs/TELEMETRY.md): as |
| 145 | contagens de uso ficam ativadas por padrão e `codewhale config set telemetry false` |
| 146 | as desativa. |
| 147 | |
| 148 | ## Documentação |
| 149 | |
| 150 | | Comece aqui | Aprofunde-se | |
| 151 | | --- | --- | |
| 152 | | [Instalação](docs/INSTALL.md) | [Configuração](docs/CONFIGURATION.md) | |
| 153 | | [Provedores e modelos locais](docs/PROVIDERS.md) | [Arquitetura](docs/ARCHITECTURE.md) | |
| 154 | | [Modos e permissões](docs/MODES.md) | [Runtime API](docs/RUNTIME_API.md) | |
| 155 | | [Atalhos de teclado](docs/KEYBINDINGS.md) | [Criação de plugins](docs/PLUGIN_AUTHORING.md) | |
| 156 | | [Revisão de PR no GitHub](docs/GITHUB_ACTION.md) | [Toda a documentação](docs/README.md) | |
| 157 | |
| 158 | ## Comunidade |
| 159 | |
| 160 | Relatos de bugs, ideias de recursos e pull requests são bem-vindos, quer você |
| 161 | use o Codewhale há meses ou esteja testando pela primeira vez. Se faltar um |
| 162 | provedor ou algum fluxo de trabalho for incômodo, |
| 163 | [abra uma issue](https://github.com/codewhale-hq/CodeWhale/issues/new/choose) ou |
| 164 | [envie um pull request](CONTRIBUTING.md). As primeiras contribuições são |
| 165 | bem-vindas, e quem contribui mantém o crédito pelo trabalho incorporado. A |
| 166 | [estrutura do repositório](CONTRIBUTING.md#project-structure) é um bom ponto de |
| 167 | partida. |
| 168 | |
| 169 | Entre no [Discord](https://discord.gg/37gfS3ksug), ou adicione o Hunter no WeChat |
| 170 | (`hunterbown`) e peça para entrar no grupo Whale Brothers. |
| 171 | |
| 172 | ## Histórico e licença |
| 173 | |
| 174 | O Codewhale começou como `deepseek-tui` e ainda lê a configuração e as sessões |
| 175 | desse projeto. Agora ele é neutro quanto a provedores, mantido de forma |
| 176 | independente e não é afiliado a nenhum provedor de modelos. Agradecemos a |
| 177 | [todos os colaboradores](docs/CONTRIBUTORS.md) e às comunidades de código aberto |
| 178 | que ajudaram o projeto a crescer. |
| 179 | |
| 180 | [MIT](LICENSE). Trechos adaptados de outros projetos de código aberto estão |
| 181 | registrados nos [avisos de terceiros](docs/THIRD_PARTY_NOTICES.md). |
| 182 |