Skip to main content

Codex CLI – Ferramentas de IA, APIs e automação para desenvolvedores. Modular, extensível, com logging, testes e documentação de referência.

Project description

Codex CLI: Seu Assistente de IA e Automação no Terminal

PyPI

Codex CLI é uma poderosa ferramenta de linha de comando projetada para desenvolvedores, engenheiros de dados e entusiastas de automação. Integre a inteligência artificial do Google Gemini diretamente no seu fluxo de trabalho, automatize tarefas repetitivas e consulte uma variedade de fontes de informação sem sair do terminal.

Com uma arquitetura extensível e foco na produtividade, o Codex CLI armazena seu histórico de interações, permite a busca por conversas passadas e oferece um conjunto de ferramentas integradas para interagir com seu sistema de arquivos e APIs externas.


🌐 Documentação Completa (Multilíngue)

Para uma experiência completa, incluindo guias de instalação, configuração de API e tutoriais detalhados, por favor, selecione seu idioma:


Instalação Rápida

pip install codex-cli-montezuma

Configuração Rápida de API Keys

Para usar todas as funcionalidades do Codex CLI, configure suas chaves de API:

# Configuração automática (recomendado)
./scripts/setup-api-keys.sh

# Ou configure manualmente:
export GOOGLE_API_KEY="sua_chave_aqui"
export GOOGLE_SEARCH_CX="seu_search_engine_id_aqui"

📚 Guia completo: docs/pt/configuracao-api-keys.md


Funcionalidades Principais

  • Inteligência Artificial Integrada: Converse com o modelo de linguagem Google Gemini para gerar código, obter explicações, traduzir textos e muito mais.
  • Histórico de Conversas: Todas as suas interações são salvas localmente em um banco de dados SQLite, permitindo que você revise e busque por informações importantes a qualquer momento.
  • Sistema de Ferramentas Extensível:
    • escrever_arquivo: Crie ou modifique arquivos no seu projeto.
    • listar_arquivos: Navegue pela estrutura de diretórios.
    • ler_arquivo: Leia o conteúdo de arquivos de texto.
    • consultar_wikipedia: Obtenha resumos rápidos da Wikipedia.
    • consultar_stackoverflow: Encontre soluções para problemas de programação.
    • consultar_google: Realize buscas na web.
    • E muito mais!
  • Suporte Multilíngue: A interface e a documentação estão disponíveis em Português e Inglês.
  • Automação de Tarefas: Use o Codex para automatizar scripts, gerar relatórios e interagir com seu ambiente de desenvolvimento.

Logging Estruturado e Depuração

O Codex CLI utiliza logging estruturado e configurável em todos os módulos, facilitando depuração, auditoria e integração com ferramentas externas.

  • O logging é centralizado em src/log_config.py.
  • Por padrão, logs são enviados para o console, mas você pode configurar para arquivo ou outros destinos.
  • Níveis suportados: DEBUG, INFO, WARNING, ERROR, CRITICAL.
  • Todos os módulos usam logger = logging.getLogger("codex.nome_do_modulo") para rastreabilidade.

Como customizar o logging:

from src.log_config import setup_logging
setup_logging(level="DEBUG", log_file="codex.log")

Ou defina variáveis de ambiente para ajustar o nível globalmente.


Arquitetura e Boas Práticas

  • Código modularizado em src/ (core, integrações, sugestões, banco, etc).
  • Todas as funções principais usam type hints e docstrings.
  • Logging estruturado em todos os fluxos.
  • Testes automatizados com pytest e mocks para integrações externas.
  • Automação de build, testes e limpeza via Makefile e scripts.
  • Extensibilidade planejada via sistema de plugins (em desenvolvimento).

Para Desenvolvedores

  • Siga o padrão de logging e type hints em todo novo código.
  • Consulte src/log_config.py para configurar logs.
  • Veja exemplos de testes e patches em tests/ e docs/guia_didatico/como_escrever_testes.md.
  • Documentação de cada ferramenta é gerada automaticamente em docs/guia_didatico/auto_documentacao_ferramentas.md.
  • Para criar novas integrações, siga o padrão de src/integrations/ e registre no dicionário FERRAMENTAS.

Publicação no PyPI e Uso como API

Veja o guia completo em docs/publicacao_pypi_api.md.

Resumo rápido:

Publicar no PyPI:

pip install build twine
python -m build
# Para o PyPI oficial:
twine upload dist/*
# Para o TestPyPI:
twine upload --repository testpypi dist/*

Expor como API (FastAPI):

from fastapi import FastAPI, Request
from codex.cli_agent import main as codex_main

app = FastAPI()

@app.post("/codex/")
async def codex_endpoint(request: Request):
    data = await request.json()
    resposta = codex_main(**data)
    return {"resposta": resposta}

Veja detalhes, exemplos e links oficiais no guia acima.


Sumário das Mudanças Recentes (2025)

  • Modularização total: Código reorganizado em src/ com separação clara de integrações, core, sugestões e banco.
  • Type hints e docstrings: Todo o código principal agora segue tipagem estática e documentação de funções.
  • Logging estruturado: Todos os módulos usam logging centralizado e configurável via src/log_config.py.
  • Testes automatizados: Cobertura total com pytest, incluindo mocks para integrações externas.
  • Automação: Makefile e scripts para build, testes, limpeza e geração de documentação.
  • Extensibilidade: Estrutura pronta para plugins e novas integrações.
  • Documentação didática: Todos os guias, exemplos e auto-documentação atualizados.
  • Personalização dinâmica: Respostas do agente adaptam tom, exemplos e dicas conforme perfil do usuário.
  • CLI aprimorado: Sugestões inteligentes, exportação de histórico, relatórios e perfil do usuário.

Consulte o diário de bordo (docs/diario_de_bordo.md) para histórico detalhado e decisões de arquitetura.


Privacidade e Histórico

  • O histórico de conversas do Codex CLI é salvo localmente no arquivo memoria_codex.db na pasta onde o comando é executado.
  • Apenas quem tem acesso ao arquivo .db pode ver o histórico.
  • O histórico não é enviado para a internet nem compartilhado entre usuários diferentes, a menos que o arquivo seja copiado manualmente.
  • Para resetar seu histórico, basta apagar o arquivo memoria_codex.db.
  • Em ambientes multiusuário, recomenda-se rodar o CLI em pastas separadas para cada usuário.

Para planos de segurança avançada (criptografia, proteção por senha, etc), consulte o roadmap ou entre em contato com o mantenedor.


Projeto didático, aberto a sugestões e contribuições!

Licença

MIT License. Consulte o arquivo LICENSE para mais detalhes.

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

codex_cli_montezuma-0.1.3.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

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

codex_cli_montezuma-0.1.3-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file codex_cli_montezuma-0.1.3.tar.gz.

File metadata

  • Download URL: codex_cli_montezuma-0.1.3.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for codex_cli_montezuma-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f5607a698ff9863eba63f4b1a4a10b43561961e36af17a98c5d2bc7a7bf59526
MD5 b949237d9decfa40b2edaaad55669818
BLAKE2b-256 80425ae931e05550405bb4e3e8325ae6c87ce5c164e3a1a85143716135a1c4e8

See more details on using hashes here.

File details

Details for the file codex_cli_montezuma-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for codex_cli_montezuma-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b7e57274378c543276ec9be9aabb02f21f557085f9f7da0c2d25788483bbdeb9
MD5 25f06c0a43a92d70ec195905570cb0ce
BLAKE2b-256 d55522683e5a1024dfb9939e6cb9b26166c8a1fa597c4e79775d8ca4eaeee779

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