englishup 0.1.0

AI-powered grammar checker for the terminal

EnglishUp

EnglishUp é uma CLI para revisar e melhorar textos em inglês no terminal.

A biblioteca oferece:

• correção gramatical (check)
• explicação de erros (explain)
• integração com shell (zsh/bash)
• sugestões ao digitar no terminal (live)
• score de qualidade e pontos de melhoria

Requisitos

• Python >= 3.9
• Chave da API da Anthropic

Instalação

pip install englishup

Configuração

Você pode configurar a chave da API de duas formas.

1) Variável de ambiente (recomendado)

export ANTHROPIC_API_KEY="sua-chave"

2) Comando da própria CLI

englishup config --api-key "sua-chave"

Para validar se a chave está configurada:

englishup config

Uso básico

Corrigir texto

englishup check "I have maked a mistake"

Corrigir texto via pipe

echo "fix the broke pipeline" | englishup check

Explicar erros

englishup explain "She don't know the answer"

Integração com shell (zsh e bash)

Instala o hook no shell atual (~/.zshrc ou ~/.bashrc):

englishup setup

Depois, recarregue o shell:

source ~/.zshrc
# ou
source ~/.bashrc

Com isso ativo, ao digitar comandos com texto em inglês (ex.: git commit -m "fix the broke pipeline"), a CLI pode sugerir melhorias.

Atalhos no modo live (zsh):

• Tab: aceita sugestão
• Esc: descarta sugestão
• Enter: executa o comando (com verificação final)

Para remover a integração:

englishup uninstall

Diagnóstico

Use o comando abaixo para validar setup, chave e conectividade:

englishup doctor

Sem chamada de API (somente validações locais):

englishup doctor --skip-api

Segurança

• Nunca commite sua chave de API.
• Prefira variável de ambiente para configurar a chave.

Comando principal

Após instalar, o entrypoint disponível é:

englishup --help