pony-bot

CLI que analisa o último commit de um projeto git e gera recomendações no estilo Extreme Go Horse.

English | Português (Brasil)

Português (Brasil)

O que faz

O pony-bot é um agente de linha de comando que:

1. Lê os arquivos alterados no último commit git
2. Analisa documentação (.md), código alterado e testes relacionados
3. Gera recomendações técnicas no estilo Extreme Go Horse, com exemplos de código

Requisitos

• Node.js 18+
• Repositório git com pelo menos um commit
• Chave de API da OpenAI

Instalação

Uso global (recomendado):

npm install -g pony-bot

Uso pontual (sem instalar):

npx pony-bot run

Configuração

Configure sua chave da OpenAI (necessário apenas uma vez):

pony-bot config set --key sk-...

Defina o idioma padrão das respostas (pt-BR é o padrão):

pony-bot config set --language pt-BR
pony-bot config set --language en

As configurações são salvas em ~/.pony-bot/config.json.

Remover a chave salva:

pony-bot config clear

Uso

Entre no diretório de qualquer projeto git e execute:

cd /caminho/do/seu/projeto
pony-bot run

Sobrescrever o idioma apenas na execução:

pony-bot run --lang en
pony-bot run --lang pt-BR

Comandos

| Comando | Descrição | |---------|-----------| | pony-bot run | Analisa o último commit e gera recomendações | | pony-bot run --lang <idioma> | Executa com idioma pt-BR ou en | | pony-bot config set --key <key> | Salva a chave da OpenAI | | pony-bot config set --language <idioma> | Define o idioma padrão | | pony-bot config clear | Remove a chave salva |

Exemplo de saída

O agente retorna recomendações formatadas no terminal, organizadas por:

• Documentação — sugestões para arquivos .md
• Código — recomendações com trechos de código
• Testes — orientações sobre testes relacionados ao commit

Desenvolvimento local

npm install
npm run build
npm run dev -- run
npm run dev -- config set --key sk-...

English

What it does

pony-bot is a command-line agent that:

1. Reads files changed in the latest git commit
2. Analyzes documentation (.md), changed code, and related tests
3. Generates Extreme Go Horse-style technical recommendations with code examples

Requirements

• Node.js 18+
• A git repository with at least one commit
• An OpenAI API key

Installation

Global install (recommended):

npm install -g pony-bot

One-off usage (no install):

npx pony-bot run

Configuration

Set your OpenAI API key (only required once):

pony-bot config set --key sk-...

Set the default response language (pt-BR is the default):

pony-bot config set --language pt-BR
pony-bot config set --language en

Settings are stored in ~/.pony-bot/config.json.

Remove the saved API key:

pony-bot config clear

Usage

Navigate to any git project directory and run:

cd /path/to/your/project
pony-bot run

Override the language for a single run:

pony-bot run --lang en
pony-bot run --lang pt-BR

Commands

| Command | Description | |---------|-------------| | pony-bot run | Analyzes the latest commit and generates recommendations | | pony-bot run --lang <language> | Runs with pt-BR or en | | pony-bot config set --key <key> | Saves the OpenAI API key | | pony-bot config set --language <language> | Sets the default language | | pony-bot config clear | Removes the saved API key |

Output example

The agent returns formatted recommendations in the terminal, organized by:

• Documentation — suggestions for .md files
• Code — recommendations with code snippets
• Tests — guidance on tests related to the commit

Local development

npm install
npm run build
npm run dev -- run
npm run dev -- config set --key sk-...

License

ISC