# 🤖 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)
```bash
# 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)
```bash
# 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)
```bash
pipx install open-agent-cli
```
## 🔧 Configuração
### Configuração Rápida
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
# 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
```bash
open-agent run "Crie uma API Python com Flask que seja um CRUD completo com dados mockados"
```
### Criar projeto React moderno
```bash
open-agent run "Crie um projeto React com TypeScript, Vite, Tailwind CSS e estrutura bem organizada"
```
### Melhorar código existente
```bash
open-agent analyze app.py "Refatore este código seguindo Clean Code e adicione validações"
```
## 📚 Documentação
- [Guia de Uso Detalhado](USAGE_GUIDE.md)
- [Guia de Migração para OpenAI](MIGRATION_TO_OPENAI.md)
- [Guia de Instalação](INSTALLATION_GUIDE.md)
## 🤝 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](LICENSE) para mais detalhes.
## 🆘 Suporte
Se você encontrar algum problema ou tiver dúvidas:
1. Verifique a [documentação](USAGE_GUIDE.md)
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**
Raw data
{
"_id": null,
"home_page": null,
"name": "open-agent-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Gustavo <gustavdesousalima@gmail.com>",
"keywords": "ai, cli, development, code-generation, openai, gemini, clean-code",
"author": null,
"author_email": "Gustavo <gustavdesousalima@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/da/92/c0e9b0e120a3c4f5751cfde389e529f3582147b515d69ff980e57a13aa1a/open_agent_cli-1.0.0.tar.gz",
"platform": null,
"description": "# \ud83e\udd16 Open Agent CLI\n\nUm agente de intelig\u00eancia artificial via linha de comando que cria projetos estruturados e c\u00f3digo limpo seguindo as melhores pr\u00e1ticas de **Clean Code** e **Clean Architecture** usando OpenAI ou Google Generative AI.\n\n## \u2728 Funcionalidades\n\n- **Clean Code & Clean Architecture**: Cria projetos seguindo as melhores pr\u00e1ticas\n- **Indenta\u00e7\u00e3o correta**: Gera c\u00f3digo com indenta\u00e7\u00e3o consistente e leg\u00edvel (4 espa\u00e7os Python, 2 JS/TS)\n- **Detec\u00e7\u00e3o autom\u00e1tica de Python3**: Corrige comandos automaticamente para usar python3/pip3\n- **M\u00faltiplos provedores**: Suporte a OpenAI e Google Gemini\n- **Configura\u00e7\u00e3o flex\u00edvel**: Ajuste modelo, provedor, temperatura e tokens facilmente\n- **Estrutura organizada**: Separa responsabilidades em pastas bem definidas\n- **Configura\u00e7\u00e3o simples**: Configure sua chave da API com um comando\n- **Comandos em linguagem natural**: Descreva o que voc\u00ea quer fazer em portugu\u00eas\n- **Manipula\u00e7\u00e3o segura de arquivos**: Cria\u00e7\u00e3o, leitura e modifica\u00e7\u00e3o de arquivos\n- **Execu\u00e7\u00e3o segura de comandos**: Comandos shell executados com seguran\u00e7a\n- **An\u00e1lise inteligente**: Entenda a estrutura e sugira melhorias\n- **Setup de projetos**: Crie projetos completos com um comando\n- **Configura\u00e7\u00e3o de deploy**: Configure deploy para diferentes plataformas\n\n## \ud83d\ude80 Instala\u00e7\u00e3o\n\n### M\u00e9todo R\u00e1pido (Recomendado)\n\n```bash\n# Clone o reposit\u00f3rio\ngit clone <repository>\ncd open-agent-cli\n\n# Instale o projeto\npip install -e .\n\n# Configure o agente\nopen-agent config\n```\n\n### Instala\u00e7\u00e3o Manual\n\n#### Via pip (recomendado)\n\n```bash\n# Instala\u00e7\u00e3o global\npip install open-agent-cli\n\n# Ou com pip3\npip3 install open-agent-cli\n\n# Em ambiente virtual\npython -m pip install open-agent-cli\n```\n\n#### Via pipx (Isolado)\n\n```bash\npipx install open-agent-cli\n```\n\n## \ud83d\udd27 Configura\u00e7\u00e3o\n\n### Configura\u00e7\u00e3o R\u00e1pida\n\n```bash\n# Configura\u00e7\u00e3o interativa (recomendado)\nopen-agent config\n\n# Ou configure diretamente\nopen-agent config --provider openai --api-key SUA_CHAVE --model gpt-4o-mini\n```\n\n### Op\u00e7\u00f5es de Configura\u00e7\u00e3o\n\n```bash\n# Ver configura\u00e7\u00e3o atual\nopen-agent config --show\n\n# Listar modelos dispon\u00edveis\nopen-agent config --list-models\n\n# Atualizar apenas o modelo\nopen-agent config --model gpt-4o-mini\n\n# Atualizar temperatura (0.0-2.0)\nopen-agent config --temperature 0.1\n\n# Atualizar max tokens\nopen-agent config --max-tokens 8000\n\n# Trocar provedor\nopen-agent config --provider google --model gemini-1.5-flash\n```\n\n### Provedores e Modelos\n\n#### OpenAI (Recomendado)\n- **gpt-4o-mini**: R\u00e1pido e econ\u00f4mico para c\u00f3digo\n- **gpt-4o**: Mais avan\u00e7ado, mas mais caro\n- **gpt-3.5-turbo**: Econ\u00f4mico e r\u00e1pido\n- **gpt-4-turbo**: Alta qualidade\n\n#### Google Gemini\n- **gemini-1.5-flash**: R\u00e1pido e econ\u00f4mico\n- **gemini-1.5-pro**: Mais avan\u00e7ado\n- **gemini-pro**: Vers\u00e3o est\u00e1vel\n\n## \ud83d\udcd6 Como Usar\n\n### Comandos B\u00e1sicos\n\n#### Executar instru\u00e7\u00f5es em linguagem natural\n\n```bash\n# Criar um projeto React com Vite\nopen-agent run \"Crie um projeto React com Vite e Tailwind CSS\"\n\n# Adicionar uma rota ao FastAPI\nopen-agent run \"Adicione uma rota /users ao meu app FastAPI que retorna um JSON\"\n\n# Configurar Docker\nopen-agent run \"Configure Docker para este projeto Python\"\n\n# Otimizar c\u00f3digo\nopen-agent run \"Otimize o c\u00f3digo deste projeto para melhor performance\"\n```\n\n#### Setup de projetos espec\u00edficos\n\n```bash\n# Criar projeto React\nopen-agent run --type react \"Crie um projeto React moderno com TypeScript\"\n\n# Criar projeto Python\nopen-agent run --type python \"Crie um projeto Python com FastAPI e SQLAlchemy\"\n\n# Criar projeto Node.js\nopen-agent run --type node \"Crie um projeto Node.js com Express e MongoDB\"\n```\n\n### Comandos de An\u00e1lise\n\n#### Listar arquivos do projeto\n\n```bash\n# Listar todos os arquivos\nopen-agent list-files\n\n# Listar arquivos Python\nopen-agent list-files --pattern \"*.py\"\n\n# Listar com conte\u00fado\nopen-agent list-files --content\n```\n\n#### Analisar arquivo espec\u00edfico\n\n```bash\n# Analisar arquivo Python\nopen-agent analyze main.py \"Analise este arquivo e sugira melhorias\"\n\n# Analisar com instru\u00e7\u00e3o espec\u00edfica\nopen-agent analyze app.py --instruction \"Adicione valida\u00e7\u00e3o de entrada e tratamento de erros\"\n```\n\n#### Sugerir melhorias\n\n```bash\n# Sugest\u00f5es gerais\nopen-agent suggest \"Como posso melhorar a performance deste projeto?\"\n\n# Sugest\u00f5es espec\u00edficas\nopen-agent suggest \"Adicione testes unit\u00e1rios e documenta\u00e7\u00e3o\"\n```\n\n### Comandos de Deploy\n\n#### Configurar deploy\n\n```bash\n# Deploy com Docker\nopen-agent deploy docker \"Configure deploy com Docker e docker-compose\"\n\n# Deploy no Heroku\nopen-agent deploy heroku \"Configure deploy no Heroku\"\n\n# Deploy em VPS\nopen-agent deploy vps \"Configure deploy em VPS com Nginx e systemd\"\n```\n\n### Comandos de Sistema\n\n#### Verificar status\n\n```bash\n# Status do agente\nopen-agent status\n\n# Mostrar configura\u00e7\u00e3o\nopen-agent config --show\n\n# Vers\u00e3o\nopen-agent version\n```\n\n## \ud83d\udee1\ufe0f Modo Seguro\n\nO agente opera em modo seguro por padr\u00e3o, que:\n\n- \u2705 Pergunta antes de sobrescrever arquivos existentes\n- \u2705 Bloqueia comandos perigosos (rm, sudo, etc.)\n- \u2705 Mostra o que ser\u00e1 executado antes de executar\n- \u2705 Permite cancelar opera\u00e7\u00f5es\n\n## \ud83d\udcb0 Custos Estimados\n\n### OpenAI GPT-4o-mini (Recomendado)\n- **Input**: $0.15 por 1M tokens\n- **Output**: $0.60 por 1M tokens\n- **Projeto t\u00edpico**: ~$0.01-0.05\n\n### OpenAI GPT-3.5-turbo (Econ\u00f4mico)\n- **Input**: $0.50 por 1M tokens\n- **Output**: $1.50 por 1M tokens\n- **Projeto t\u00edpico**: ~$0.02-0.10\n\n## \ud83c\udfaf Exemplos de Uso\n\n### Criar API Python com Flask\n\n```bash\nopen-agent run \"Crie uma API Python com Flask que seja um CRUD completo com dados mockados\"\n```\n\n### Criar projeto React moderno\n\n```bash\nopen-agent run \"Crie um projeto React com TypeScript, Vite, Tailwind CSS e estrutura bem organizada\"\n```\n\n### Melhorar c\u00f3digo existente\n\n```bash\nopen-agent analyze app.py \"Refatore este c\u00f3digo seguindo Clean Code e adicione valida\u00e7\u00f5es\"\n```\n\n## \ud83d\udcda Documenta\u00e7\u00e3o\n\n- [Guia de Uso Detalhado](USAGE_GUIDE.md)\n- [Guia de Migra\u00e7\u00e3o para OpenAI](MIGRATION_TO_OPENAI.md)\n- [Guia de Instala\u00e7\u00e3o](INSTALLATION_GUIDE.md)\n\n## \ud83e\udd1d Contribuindo\n\n1. Fork o projeto\n2. Crie uma branch para sua feature (`git checkout -b feature/AmazingFeature`)\n3. Commit suas mudan\u00e7as (`git commit -m 'Add some AmazingFeature'`)\n4. Push para a branch (`git push origin feature/AmazingFeature`)\n5. Abra um Pull Request\n\n## \ud83d\udcc4 Licen\u00e7a\n\nEste projeto est\u00e1 sob a licen\u00e7a MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.\n\n## \ud83c\udd98 Suporte\n\nSe voc\u00ea encontrar algum problema ou tiver d\u00favidas:\n\n1. Verifique a [documenta\u00e7\u00e3o](USAGE_GUIDE.md)\n2. Use `open-agent status` para verificar a configura\u00e7\u00e3o\n3. Use `open-agent config --show` para ver as configura\u00e7\u00f5es atuais\n4. Abra uma issue no GitHub\n\n---\n\n**Desenvolvido com \u2764\ufe0f para facilitar o desenvolvimento de software** \n",
"bugtrack_url": null,
"license": null,
"summary": "\ud83e\udd16 CLI de IA para desenvolvimento - Cria projetos estruturados e c\u00f3digo limpo usando OpenAI ou Google Gemini",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/gustavodesousalima/open-agent-cli/issues",
"Documentation": "https://github.com/gustavodesousalima/open-agent-cli#readme",
"Homepage": "https://github.com/gustavodesousalima/open-agent-cli",
"Repository": "https://github.com/gustavodesousalima/open-agent-cli"
},
"split_keywords": [
"ai",
" cli",
" development",
" code-generation",
" openai",
" gemini",
" clean-code"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f4d36b0cc0106ba8ce0cda92d638c5e03d6e8adea5336ae05f8b43f24873e698",
"md5": "5687527e95ff1cf657e469b44d59ea08",
"sha256": "c2dca4d3266f5e63c46e3a92a948328a1d35dbac6b3b4ff24591229fdc71e5e3"
},
"downloads": -1,
"filename": "open_agent_cli-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5687527e95ff1cf657e469b44d59ea08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24094,
"upload_time": "2025-07-10T01:05:15",
"upload_time_iso_8601": "2025-07-10T01:05:15.867514Z",
"url": "https://files.pythonhosted.org/packages/f4/d3/6b0cc0106ba8ce0cda92d638c5e03d6e8adea5336ae05f8b43f24873e698/open_agent_cli-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "da92c0e9b0e120a3c4f5751cfde389e529f3582147b515d69ff980e57a13aa1a",
"md5": "740ae00ba64f271a03f51d8702dd6543",
"sha256": "19a8f30e26f219e1a64f0ccbc85eff8d76ea9bfb6d9fa4db89f854ee0a0a9feb"
},
"downloads": -1,
"filename": "open_agent_cli-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "740ae00ba64f271a03f51d8702dd6543",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23446,
"upload_time": "2025-07-10T01:05:17",
"upload_time_iso_8601": "2025-07-10T01:05:17.550571Z",
"url": "https://files.pythonhosted.org/packages/da/92/c0e9b0e120a3c4f5751cfde389e529f3582147b515d69ff980e57a13aa1a/open_agent_cli-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-10 01:05:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gustavodesousalima",
"github_project": "open-agent-cli",
"github_not_found": true,
"lcname": "open-agent-cli"
}
JSON
