| 1 | <!-- source: README.md sha256:a87c9f323f35 --> |
| 2 | # Codewhale |
| 3 | |
| 4 | Um agente de programação de código aberto para o seu terminal — traga o seu próprio modelo. |
| 5 | |
| 6 | O Codewhale começou como uma experiência nativa para o DeepSeek. Desde então, |
| 7 | virou um projeto guiado pela comunidade: um harness de programação que se |
| 8 | encaixa em uma comunidade internacional em crescimento e suporta o máximo de |
| 9 | modelos e provedores possível — modelos abertos primeiro, hospedados ou locais, |
| 10 | sem privilegiar nenhum. |
| 11 | |
| 12 | Você informa um provedor, um modelo e uma tarefa. Ele lê seu código, edita |
| 13 | arquivos, executa comandos e verifica o próprio trabalho, e para quando a tarefa |
| 14 | termina ou quando precisa de você. Troque de modelo no meio da tarefa com |
| 15 | `/model`. Trabalhe de forma interativa na TUI, ou rode `codewhale exec` em |
| 16 | scripts e CI. É escrito em Rust, licenciado sob MIT, e roda na sua máquina. |
| 17 | |
| 18 | Estamos sempre em busca de pessoas que contribuam e de formas de melhorar. Se um |
| 19 | modelo ou provedor que você usa está faltando, ou se algo quebra, nos contar é |
| 20 | uma das coisas mais úteis que você pode fazer — veja [Contribuindo](#contribuindo). |
| 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) · [codewhale.net](https://codewhale.net/) · [Docs](docs) · [Changelog](CHANGELOG.md) · [Discord](https://discord.gg/37gfS3ksug) |
| 23 | |
| 24 | [](https://github.com/Hmbown/CodeWhale/actions/workflows/ci.yml) |
| 25 | [](https://crates.io/crates/codewhale-cli) |
| 26 | [](https://www.npmjs.com/package/codewhale) |
| 27 | [](https://discord.gg/37gfS3ksug) |
| 28 | |
| 29 |  |
| 30 | |
| 31 | ## Instalação |
| 32 | |
| 33 | ```bash |
| 34 | npm install -g codewhale |
| 35 | ``` |
| 36 | |
| 37 | Cargo, Docker, Nix, Scoop, arquivos pré-compilados, Android/Termux e um |
| 38 | espelho CNB para quem não consegue acessar o GitHub estão cobertos em |
| 39 | [docs/INSTALL.md](docs/INSTALL.md). Vindo do `deepseek-tui`? Sua configuração |
| 40 | e suas sessões são preservadas — veja [docs/REBRAND.md](docs/REBRAND.md). |
| 41 | |
| 42 | ## Uso |
| 43 | |
| 44 | ```bash |
| 45 | codewhale auth set --provider deepseek # or export ANTHROPIC_API_KEY, etc. |
| 46 | codewhale # open the TUI |
| 47 | codewhale exec "fix the failing test" # headless |
| 48 | codewhale web # local browser client on 127.0.0.1 |
| 49 | ``` |
| 50 | |
| 51 | |
| 52 | Na TUI: `/model` troca provedor e modelo juntos, `/fleet` executa uma equipe |
| 53 | de workers, `/undo` desfaz o último turno e `/restore <N>` reverte o workspace |
| 54 | para um snapshot anterior (`/restore` sem argumento apenas os lista). Quando o |
| 55 | compositor está vazio, `Tab` cicla entre Plan / Act / Operate; com texto |
| 56 | digitado, `Tab` completa comandos slash e menções `@`. `Shift+Tab` cicla a |
| 57 | postura de permissão Ask / Auto-Review / Full Access a qualquer momento. `!` |
| 58 | executa um comando de shell pelo caminho normal de aprovação. |
| 59 | |
| 60 | ## O que faz |
| 61 | |
| 62 | - **Qualquer modelo, qualquer provedor.** DeepSeek, Claude, GPT, Kimi, GLM e |
| 63 | mais de 30 provedores, além do seu próprio vLLM, SGLang ou Ollama sem key — |
| 64 | tudo por um único runtime e um único conjunto de ferramentas. Orçamentos de |
| 65 | contexto e preços vêm da rota real, e um preço desconhecido aparece como |
| 66 | desconhecido em vez de $0. |
| 67 | - **Somente leitura até você permitir mais.** O modo Plan não altera arquivos, |
| 68 | e as aprovações controlam os comandos arriscados. Quando um sandbox do |
| 69 | sistema operacional realmente envolve um comando, o Codewhale avisa: Seatbelt |
| 70 | no macOS quando disponível, bubblewrap opcional no Linux. O |
| 71 | `constitution.json` de um repositório é compilado em bloqueios de escrita |
| 72 | que nem o Full Access consegue pular. |
| 73 | - **Trabalho que você pode retomar.** Um fleet registra cada passo em um |
| 74 | livro-razão de apenas inclusão, então `fleet resume` retoma de onde você |
| 75 | parou. |
| 76 | |
| 77 | ## Saiba mais |
| 78 | |
| 79 | - [docs/PROVIDERS.md](docs/PROVIDERS.md) — cada rota de provedor: hospedada, |
| 80 | gateway e local |
| 81 | - [docs/FLEET.md](docs/FLEET.md) — fleets, o livro-razão e resume |
| 82 | - [docs/WORKFLOW_EXPERIMENTAL_SEARCH.md](docs/WORKFLOW_EXPERIMENTAL_SEARCH.md) — |
| 83 | busca experimental congelada e neutra em relação a provedores dentro do |
| 84 | Workflow |
| 85 | - [docs/CONFIGURATION.md](docs/CONFIGURATION.md) — `config.toml`, hooks e a |
| 86 | constitution |
| 87 | - [docs/AUTHORIZATION_ORDER.md](docs/AUTHORIZATION_ORDER.md) — como modos, hooks, |
| 88 | regras de permissão, limites mínimos de segurança, regras do repositório, |
| 89 | aprovações e sandboxing se combinam |
| 90 | - [docs/HOOKS.md](docs/HOOKS.md) — os onze eventos de hook do ciclo de vida da |
| 91 | TUI, seus payloads e os três que podem direcionar um turno (`codewhale exec` |
| 92 | e os subcomandos da CLI não disparam hooks) |
| 93 | - [docs/WEB.md](docs/WEB.md) — cliente de navegador incorporado apenas em |
| 94 | loopback e sua fronteira de autenticação de uso único |
| 95 | |
| 96 | Todo o resto — modos, atalhos de teclado, detalhes do sandbox, MCP, a API do |
| 97 | runtime, arquitetura — está em [docs](docs) e em |
| 98 | [codewhale.net](https://codewhale.net/). |
| 99 | |
| 100 | ## Contribuindo |
| 101 | |
| 102 | Issues, PRs, passos de reprodução, logs e pedidos de funcionalidade são trabalho |
| 103 | real do projeto, e primeiras contribuições são bem-vindas. Quando um PR não pode |
| 104 | ser mesclado como está, os mantenedores aproveitam o que funciona e o autor |
| 105 | continua creditado — no commit, no changelog e em |
| 106 | [docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md). |
| 107 | |
| 108 | - [Issues abertas](https://github.com/Hmbown/CodeWhale/issues) — boas |
| 109 | primeiras contribuições moram aqui |
| 110 | - [CONTRIBUTING.md](CONTRIBUTING.md) — setup de desenvolvimento e fluxo de PR |
| 111 | - [docs/CONTRIBUTORS.md](docs/CONTRIBUTORS.md) — todo mundo que ajudou a |
| 112 | moldar o projeto |
| 113 | - [Me pague um café](https://www.buymeacoffee.com/hmbown) |
| 114 | |
| 115 | Obrigado à [DeepSeek](https://github.com/deepseek-ai) pelos modelos e pelo |
| 116 | apoio que deram início ao projeto, à |
| 117 | [DataWhale](https://github.com/datawhalechina) 🐋 por nos receber na família |
| 118 | Whale Brother, e a [OpenWarp](https://github.com/zerx-lab/warp) e |
| 119 | [Open Design](https://github.com/nexu-io/open-design) pela colaboração na |
| 120 | experiência de agente no terminal. |
| 121 | |
| 122 | ## Licença |
| 123 | |
| 124 | [MIT](LICENSE). Projeto comunitário independente; sem afiliação com nenhum |
| 125 | provedor de modelos. |
| 126 | |
| 127 | [](https://www.star-history.com/?repos=Hmbown%2FCodeWhale&type=date) |
| 128 |