Skip to main content

🤖 CLI de IA para desenvolvimento - Cria projetos estruturados e código limpo usando OpenAI ou Google Gemini

Project description

🤖 Open Agent CLI

Um agente de inteligência artificial via linha de comando que cria projetos estruturados e código limpo seguindo as melhores práticas de Clean Code e Clean Architecture usando OpenAI ou Google Generative AI.

✨ Funcionalidades

  • Clean Code & Clean Architecture: Cria projetos seguindo as melhores práticas
  • Indentação correta: Gera código com indentação consistente e legível (4 espaços Python, 2 JS/TS)
  • Detecção automática de Python3: Corrige comandos automaticamente para usar python3/pip3
  • Múltiplos provedores: Suporte a OpenAI e Google Gemini
  • Configuração flexível: Ajuste modelo, provedor, temperatura e tokens facilmente
  • Estrutura organizada: Separa responsabilidades em pastas bem definidas
  • Configuração simples: Configure sua chave da API com um comando
  • Comandos em linguagem natural: Descreva o que você quer fazer em português
  • Manipulação segura de arquivos: Criação, leitura e modificação de arquivos
  • Execução segura de comandos: Comandos shell executados com segurança
  • Análise inteligente: Entenda a estrutura e sugira melhorias
  • Setup de projetos: Crie projetos completos com um comando
  • Configuração de deploy: Configure deploy para diferentes plataformas

🚀 Instalação

Método Rápido (Recomendado)

# Clone o repositório
git clone <repository>
cd open-agent-cli

# Instale o projeto
pip install -e .

# Configure o agente
open-agent config

Instalação Manual

Via pip (recomendado)

# Instalação global
pip install open-agent-cli

# Ou com pip3
pip3 install open-agent-cli

# Em ambiente virtual
python -m pip install open-agent-cli

Via pipx (Isolado)

pipx install open-agent-cli

🔧 Configuração

Configuração Rápida

# Configuração interativa (recomendado)
open-agent config

# Ou configure diretamente
open-agent config --provider openai --api-key SUA_CHAVE --model gpt-4o-mini

Opções de Configuração

# Ver configuração atual
open-agent config --show

# Listar modelos disponíveis
open-agent config --list-models

# Atualizar apenas o modelo
open-agent config --model gpt-4o-mini

# Atualizar temperatura (0.0-2.0)
open-agent config --temperature 0.1

# Atualizar max tokens
open-agent config --max-tokens 8000

# Trocar provedor
open-agent config --provider google --model gemini-1.5-flash

Provedores e Modelos

OpenAI (Recomendado)

  • gpt-4o-mini: Rápido e econômico para código
  • gpt-4o: Mais avançado, mas mais caro
  • gpt-3.5-turbo: Econômico e rápido
  • gpt-4-turbo: Alta qualidade

Google Gemini

  • gemini-1.5-flash: Rápido e econômico
  • gemini-1.5-pro: Mais avançado
  • gemini-pro: Versão estável

📖 Como Usar

Comandos Básicos

Executar instruções em linguagem natural

# Criar um projeto React com Vite
open-agent run "Crie um projeto React com Vite e Tailwind CSS"

# Adicionar uma rota ao FastAPI
open-agent run "Adicione uma rota /users ao meu app FastAPI que retorna um JSON"

# Configurar Docker
open-agent run "Configure Docker para este projeto Python"

# Otimizar código
open-agent run "Otimize o código deste projeto para melhor performance"

Setup de projetos específicos

# Criar projeto React
open-agent run --type react "Crie um projeto React moderno com TypeScript"

# Criar projeto Python
open-agent run --type python "Crie um projeto Python com FastAPI e SQLAlchemy"

# Criar projeto Node.js
open-agent run --type node "Crie um projeto Node.js com Express e MongoDB"

Comandos de Análise

Listar arquivos do projeto

# Listar todos os arquivos
open-agent list-files

# Listar arquivos Python
open-agent list-files --pattern "*.py"

# Listar com conteúdo
open-agent list-files --content

Analisar arquivo específico

# Analisar arquivo Python
open-agent analyze main.py "Analise este arquivo e sugira melhorias"

# Analisar com instrução específica
open-agent analyze app.py --instruction "Adicione validação de entrada e tratamento de erros"

Sugerir melhorias

# Sugestões gerais
open-agent suggest "Como posso melhorar a performance deste projeto?"

# Sugestões específicas
open-agent suggest "Adicione testes unitários e documentação"

Comandos de Deploy

Configurar deploy

# Deploy com Docker
open-agent deploy docker "Configure deploy com Docker e docker-compose"

# Deploy no Heroku
open-agent deploy heroku "Configure deploy no Heroku"

# Deploy em VPS
open-agent deploy vps "Configure deploy em VPS com Nginx e systemd"

Comandos de Sistema

Verificar status

# Status do agente
open-agent status

# Mostrar configuração
open-agent config --show

# Versão
open-agent version

🛡️ Modo Seguro

O agente opera em modo seguro por padrão, que:

  • ✅ Pergunta antes de sobrescrever arquivos existentes
  • ✅ Bloqueia comandos perigosos (rm, sudo, etc.)
  • ✅ Mostra o que será executado antes de executar
  • ✅ Permite cancelar operações

💰 Custos Estimados

OpenAI GPT-4o-mini (Recomendado)

  • Input: $0.15 por 1M tokens
  • Output: $0.60 por 1M tokens
  • Projeto típico: ~$0.01-0.05

OpenAI GPT-3.5-turbo (Econômico)

  • Input: $0.50 por 1M tokens
  • Output: $1.50 por 1M tokens
  • Projeto típico: ~$0.02-0.10

🎯 Exemplos de Uso

Criar API Python com Flask

open-agent run "Crie uma API Python com Flask que seja um CRUD completo com dados mockados"

Criar projeto React moderno

open-agent run "Crie um projeto React com TypeScript, Vite, Tailwind CSS e estrutura bem organizada"

Melhorar código existente

open-agent analyze app.py "Refatore este código seguindo Clean Code e adicione validações"

📚 Documentação

🤝 Contribuindo

  1. Fork o projeto
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

📄 Licença

Este projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

🆘 Suporte

Se você encontrar algum problema ou tiver dúvidas:

  1. Verifique a documentação
  2. Use open-agent status para verificar a configuração
  3. Use open-agent config --show para ver as configurações atuais
  4. Abra uma issue no GitHub

Desenvolvido com ❤️ para facilitar o desenvolvimento de software

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_agent_cli-1.0.0.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_agent_cli-1.0.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file open_agent_cli-1.0.0.tar.gz.

File metadata

  • Download URL: open_agent_cli-1.0.0.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for open_agent_cli-1.0.0.tar.gz
Algorithm Hash digest
SHA256 19a8f30e26f219e1a64f0ccbc85eff8d76ea9bfb6d9fa4db89f854ee0a0a9feb
MD5 740ae00ba64f271a03f51d8702dd6543
BLAKE2b-256 da92c0e9b0e120a3c4f5751cfde389e529f3582147b515d69ff980e57a13aa1a

See more details on using hashes here.

File details

Details for the file open_agent_cli-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: open_agent_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for open_agent_cli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2dca4d3266f5e63c46e3a92a948328a1d35dbac6b3b4ff24591229fdc71e5e3
MD5 5687527e95ff1cf657e469b44d59ea08
BLAKE2b-256 f4d36b0cc0106ba8ce0cda92d638c5e03d6e8adea5336ae05f8b43f24873e698

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page