Skip to content

Latest commit

 

History

History
100 lines (61 loc) · 8.51 KB

File metadata and controls

100 lines (61 loc) · 8.51 KB

Codewhale

Codewhale é um agente de código aberto que lê seu projeto, edita arquivos, executa comandos e verifica o próprio trabalho usando um modelo hospedado ou local à sua escolha. Comece com uma tarefa no terminal. Para um trabalho maior, distribua partes do trabalho entre agentes com diferentes modelos e funções.

Codewhale em execução em um terminal

Prévia do terminal em uma build de desenvolvimento da v0.9.12.

English · 简体中文 · 日本語 · Tiếng Việt · Bahasa Indonesia · 한국어 · Español · Русский · Українська · Français · Deutsch · 繁體中文 · हिन्दी · Türkçe · Italiano · Polski · العربية · Català

CI crates.io npm Discord

Instalação

Para uma nova instalação no macOS ou Linux, use a versão oficial do GitHub:

curl -fsSL https://codewhale.net/install.sh | sh
"$HOME/.local/bin/codewhale"

O instalador seleciona a versão publicada mais recente. O histórico de alterações também descreve a versão candidata ainda não publicada da próxima versão; essas alterações só são incluídas nos downloads publicados quando a versão estiver disponível.

No Windows, baixe o instalador ou arquivo correspondente em GitHub Releases. Para atualizar uma instalação direta existente, execute codewhale update, ou codewhale update --check apenas para verificar. O atualizador mostra o caminho do executável e preserva builds mais recentes. npm e Cargo são opções secundárias; consulte o guia de instalação para migrar de um gerenciador de pacotes e configurar PATH.

Na primeira execução, o Codewhale ajuda você a conectar um provedor ou a configurar o Codewhale offline. As respostas exigem um modelo hospedado ou local conectado. O Codewhale também oferece suporte a npm e Cargo como opções secundárias de distribuição, além de Docker, Nix, Scoop, Android/Termux e um espelho CNB opcional. Instalações existentes feitas por gerenciadores de pacotes recebem instruções de migração. Consulte a ajuda de instalação e PATH.

O preenchimento automático com Tab é ativado com um comando por shell — codewhale completion bash|zsh|fish|powershell|elvish. Consulte o preenchimento automático do shell.

Uso

Abra um terminal na pasta do seu projeto e execute codewhale. Escolha seu provedor com /provider e seu modelo com /model. Depois, descreva uma tarefa concreta:

Fix the failing tests and explain what changed.

Ou execute uma tarefa sem abrir a TUI:

codewhale exec "fix the failing tests and explain what changed"

O Codewhale pode ler seu repositório, editar arquivos, executar comandos, verificar resultados e continuar trabalhando em direção a um objetivo. Use /mode plan para explorar sem alterar arquivos nem executar comandos de shell, e /mode work quando quiser que ele faça alterações. Pressione Shift+Tab para escolher Ask, Auto-Review ou Full Access; o guia de modos e permissões explica o que cada opção permite.

Terminal, aplicativos e Computer Use

O terminal e os clientes gráficos se conectam ao Runtime do Codewhale, que executa o agente e suas ferramentas:

  • Terminal: codewhale abre a interface interativa; codewhale exec executa uma tarefa a partir de um script ou de um job de CI.
  • Navegador local: codewhale web abre o cliente web local incluído, que usa o mesmo runtime.
  • Aplicativos web e desktop do Codewhale: ambientes de trabalho gráficos em desenvolvimento. A disponibilidade é informada na página do produto.

Computer Use adiciona ferramentas para observar outros aplicativos e interagir com eles. O plugin está incluído no código-fonte atual. Revise o acesso solicitado e habilite-o antes de usar; as permissões do sistema operacional e os requisitos da plataforma continuam sendo necessários. Consulte o guia de Computer Use incluído e a configuração de plugins.

Para VS Code, a extensão CodeWhale mantida pela comunidade se conecta ao Runtime local por uma barra lateral. Instale pelo VS Code Marketplace; o código-fonte está no GitHub.

Por que usar o Codewhale

  • Escolha seus modelos. Conecte provedores hospedados ou modelos locais por meio do Ollama, vLLM ou SGLang. Use /provider para trocar de provedor e /model para escolher um modelo.
  • Mantenha o controle. Revise as ações propostas e as alterações resultantes nos arquivos. As configurações de aprovação determinam quando uma revisão é necessária; Full Access continua respeitando os limites obrigatórios das políticas. /undo e /restore ajudam a recuperar alterações no espaço de trabalho.
  • Mantenha trabalhos longos organizados. Salve sessões, defina um /goal duradouro, revise os fluxos de trabalho antes da execução e coordene agentes sem transformar as instruções internas deles em parte da sua conversa.
  • Amplie o agente que você já tem. Conecte servidores MCP e habilidades, configure hooks e mantenha as funções dos agentes como arquivos legíveis no projeto ou nas suas configurações pessoais.

Execute /help na TUI para ver comandos e atalhos de teclado.

Segurança

O Codewhale é executado na sua máquina com o acesso que você conceder. Os modos de aprovação e as regras do repositório limitam o que o agente pode fazer; o sandbox opcional do sistema operacional adiciona um limite de execução mais forte quando disponível. Preços de modelos desconhecidos continuam sendo mostrados como desconhecidos, em vez de serem informados como gratuitos.

Leia a ordem de autorização para conhecer a hierarquia exata das políticas e a configuração para os ajustes locais.

Documentação

Participe da comunidade

Relatos de bugs, ideias de funcionalidades e pull requests são bem-vindos, tanto de quem usa o Codewhale há meses quanto de quem está experimentando pela primeira vez. Se estiver faltando um provedor, se um fluxo de trabalho for inconveniente ou se a interface do terminal atrapalhar, abra uma issue ou envie um pull request para melhorarmos juntos. Primeiras contribuições são bem-vindas, e os contribuidores mantêm o crédito pelo trabalho incorporado ao projeto.

Participe do Discord, ou adicione Hunter no WeChat (hunterbown) e peça para entrar no grupo Whale Brothers.

História do projeto

O Codewhale começou como deepseek-tui e ainda preserva a compatibilidade com as configurações e sessões desse projeto. Hoje ele é neutro em relação a provedores, mantido de forma independente e não tem afiliação com nenhum provedor de modelos.

Agradecemos a cada contribuidor e às comunidades de código aberto que ajudaram o projeto a crescer. Consulte o registro de contribuidores.

Licença

MIT. As partes adaptadas de outros projetos de código aberto estão registradas nos avisos de terceiros.