OpenAI Codex CLI: um assistente de codificação de IA de linha de comando de terminal lançado pela OpenAI

Introdução geral

O OpenAI Codex CLI é uma ferramenta de codificação de terminal de código aberto desenvolvida pela OpenAI para desenvolvedores acostumados a terminais. Ele gera código, edita arquivos e executa comandos por meio de comandos de linguagem natural e integra o controle de versão do Git. O Codex CLI usa os modelos mais recentes da OpenAI (como o3 e o4-mini), oferece suporte à programação multilíngue e fornece um ambiente sandbox seguro que restringe o acesso à rede e a manipulação de diretórios para garantir a segurança. O projeto é totalmente de código aberto, incentiva as contribuições da comunidade e é adequado para desenvolvimento rápido, automatização de tarefas e aprendizado de programação.

Lista de funções

• Geração de código: gere código Python, JavaScript e outros códigos multilíngues com base em linguagem natural.
• Operações de arquivo: crie e edite arquivos, ofereça suporte a confirmações e controle de versão do Git.
• Execução de comandos: execute códigos ou comandos na área restrita e exiba os resultados em tempo real.
• Entrada multimodal: suporta captura de tela e entrada de gráfico para gerar o código correspondente.
• Sandbox de segurança: desative a rede por padrão e opere apenas o diretório atual por segurança.
• Aprovação automatizada: oferece três modos: manual, edição automática e totalmente automatizada.
• Desenvolvimento de código aberto: permite que os usuários visualizem o código, enviem recursos de contribuição de PR.
• Documentação do projeto: suporte para comandos Markdown globais e em nível de projeto, comportamento personalizado.

Usando a Ajuda

Processo de instalação

Para usar a CLI do Codex, conclua as etapas de instalação a seguir:

1. Requisitos do sistema::
   • Sistema operacional: macOS 12+, Ubuntu 20.04+/Debian 10+ ou Windows 11 (via WSL2).
   • Node.js: versão >= 22 (versão LTS recomendada).
   • Git: versão >= 2.23 (recomendada, para controle de versão).
   • RAM: pelo menos 4 GB, sendo recomendável 8 GB.
   • Chave de API da OpenAI: obtenha-a no site da OpenAI.
2. Etapas de instalação::
   • Instale globalmente via npm (recomendado):

     npm install -g @openai/codex
     

   • ou criar a partir do código-fonte:

     git clone https://github.com/openai/codex.git
     cd codex/codex-cli
     npm install
     npm run build
     

   • Defina a chave da API:

     export OPENAI_API_KEY="your-api-key-here"
     

     Para uma configuração permanente, adicione-a ao arquivo de configuração do shell (por exemplo ~/.zshrc talvez ~/.bashrc):

     echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
     source ~/.zshrc
     

   • Verifique a instalação:

     codex --help
     

     Se a mensagem de ajuda for exibida, a instalação foi bem-sucedida.

3. Configuração do Docker para Linux::
   • O Docker é recomendado para aumentar a segurança:

     ./run_in_container.sh
     

   • Certifique-se de que o Docker esteja instalado; o script montará automaticamente o diretório atual e configurará o firewall para permitir apenas o acesso à API do OpenAI.
4. advertência::
   • Não use sudo npm install -gdeve corrigir as permissões do npm:

     sudo chown -R $(whoami) ~/.npm
     

   • Certifique-se de que a chave da API seja válida para evitar 401 talvez 429 Erro.

Uso

O Codex CLI oferece uma experiência de codificação eficiente, combinando linguagem natural e ambiente sandbox por meio de operações de comando no terminal. Abaixo está o fluxo de como usar os principais recursos:

1. geração de código

• fluxo de trabalho::
  • Padrões de interação:

    codex
    

    Digite um prompt como "Create a Python function to compute a Fibonacci series" (Criar uma função Python para calcular uma série de Fibonacci).

  • Modo de comando único:

    codex "生成 JavaScript 过滤数组函数"
    

  • A CLI do Codex gera código e exibe uma visualização.
  • importação y Aceite e salve, digite n Rejeição.
• Opções avançadas::
  • Especifique o modelo:

    codex --model o4-mini "生成 Go HTTP 服务器"
    

  • Modo não interativo:

    codex -q "生成 SQL 查询" > output.sql
    

• Funções em destaque::
  • Suporte para Python, JavaScript, TypeScript, Go, SQL e muito mais.
  • Pode lidar com tarefas complexas, como "Gerar um aplicativo Flask com autenticação de usuário".

2. manipulação de arquivos e integração com o Git

• fluxo de trabalho::
  • Editar arquivo:

    codex "在 src/app.js 中添加登录功能"
    

  • A CLI do Codex exibe as diferenças de código, confirma-as e as salva.
  • Comprometer-se com o Git:

    codex "提交更改，消息为 '添加登录功能'"
    

• Funções em destaque::
  • Manipular automaticamente os comandos do Git (addecommit).
  • Oferece suporte a operações em lote, como:

    codex "重命名所有 *.jpeg 为 *.jpg 并更新引用"
    

  • São fornecidos três modos de aprovação:
    • suggestPadrão: Padrão, todas as alterações precisam ser confirmadas manualmente.
    • auto-editAplica automaticamente as alterações nos arquivos; os comandos precisam ser confirmados.
    • full-autoTotalmente automático e deve ser usado com cautela:

      codex --approval-mode full-auto "更新 README"
      

3. executar o código

• fluxo de trabalho::
  • Execute o código:

    codex "运行 src/main.py"
    

  • A CLI do Codex é executada na área restrita e exibe os resultados.
  • Se uma dependência estiver faltando, solicite a instalação dela:

    codex "安装 numpy 并运行 script.py"
    

• Funções em destaque::
  • O macOS usa o sandbox Apple Seatbelt e o Linux usa o Docker.
  • As redes são desativadas por padrão para evitar acesso acidental.
  • Oferece suporte à saída de depuração para mostrar detalhes de erros.

4. entradas multimodais

• fluxo de trabalho::
  • Digite o caminho da imagem:

    codex "根据 ui.png 实现界面代码"
    

  • A CLI do Codex analisa imagens para gerar HTML/CSS ou código de front-end.
• Funções em destaque::
  • Suporte para conversão de design de interface do usuário em código.
  • Diagramas ou fluxogramas podem ser processados para gerar código lógico.

5. configuração e personalização

• arquivo de configuração::
  • Configuração global:~/.codex/config.yaml::

    model: o4-mini
    fullAutoErrorMode: ask-user
    

  • Arquivo de instruções:~/.codex/instructions.md::

    - 使用 Python 3.9
    - 禁止自动提交 Git
    

  • Configuração em nível de projeto: o codex.md::

    - 优先使用 TypeScript
    - 运行测试前执行 npm run lint
    

• Desativar a documentação do projeto::

  codex --no-project-doc

• Mudança de modo de aprovação::

  codex --approval-mode auto-edit
  

6. integração de CI/CD

• fluxo de trabalho::
  • Execute-o em GitHub Actions:

    - name: 更新文档
    run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit -q "更新 CHANGELOG"
    

  • Defina o modo silencioso:

    export CODEX_QUIET_MODE=1
    

• Funções em destaque::
  • Oferece suporte ao modo não interativo, adequado para processos automatizados.
  • Gera o formato JSON para facilitar a criação de scripts:

    codex -q --json "生成配置"
    

advertência

• Certifique-se de que o diretório seja rastreado pelo Git.full-auto emitirá um aviso em diretórios que não sejam do Git.
• Verifique a cota da chave de API, pois chamadas frequentes podem acionar limites.
• O projeto é experimental e pode ter recursos instáveis, portanto, recomendamos que você siga o GitHub para obter atualizações.

cenário do aplicativo

1. Prototipagem rápida
   Os desenvolvedores podem gerar rapidamente estruturas de código em linguagem natural. Por exemplo, digite "Criar um aplicativo Express com um banco de dados" e a CLI do Codex gera rotas, modelos e arquivos de configuração adequados para validar ideias.
2. Tarefas automatizadas
   A CLI do Codex simplifica tarefas repetitivas, como "atualizar avisos de direitos autorais em todos os arquivos e enviar". Ele edita arquivos automaticamente, executa scripts e faz push para o Git para operações em lote.
3. Aprendizado de programação
   Os iniciantes podem digitar "Quick Sort in Python", e a CLI do Codex gera o código e explica a lógica, adequada para estudo autônomo ou ensino em sala de aula.
4. Colaboração de código aberto
   Os desenvolvedores podem participar do desenvolvimento da CLI do Codex via GitHub, enviar correções de bugs ou novos recursos, e a base de código transparente facilita a colaboração.
5. Pipeline de CI/CD
   Em ambientes de CI, o Codex CLI atualiza automaticamente a documentação, gera casos de teste ou corrige erros de lint, melhorando a eficiência do desenvolvimento.

QA

1. Qual é a diferença entre o Codex CLI e o modelo do Codex 2021?
   A CLI do Codex é uma ferramenta de endpoint mais avançada e de código aberto baseada nos modelos mais recentes da OpenAI (o3, o4-mini), independente dos modelos do Codex que serão descontinuados em 2021.
2. Como posso garantir uma operação segura?
   A CLI do Codex é executada em uma área restrita por padrão, usa o Apple Seatbelt para macOS e o Docker para Linux, desativa a rede e restringe o acesso ao diretório para evitar riscos ao sistema.
3. Quais linguagens de programação são compatíveis?
   Python, JavaScript, TypeScript, Go, SQL etc. são compatíveis, conforme determinado pelo modelo OpenAI usado, e a linguagem pode ser especificada por meio de um comando.
4. A CLI do Codex é gratuita?
   A CLI do Codex em si é gratuita, mas requer uma chave de API da OpenAI e pode incorrer em custos para chamadas de API; consulte Preços da OpenAI para obter detalhes.
5. Como faço para impedir que a CLI do Codex modifique arquivos?
   fazer uso de suggest todas as alterações precisam ser confirmadas manualmente:

   codex --approval-mode suggest