← Todos os guias

Codex CLI

O agente de terminal oficial da OpenAI.

O Codex usa a API compatível com OpenAI, então pode conversar com mais do que api.openai.com. Use sua chave OpenAI diretamente ou declare um provedor personalizado no arquivo de configuração.

Documentação oficial ↗

Passos de configuração

1. 1

   Instale a CLI

   Requer Node.js 18 ou mais recente. Instala o comando global codex.

   bashCopiar

   npm install -g @openai/codex

2. 2

   Opção A: use sua chave OpenAI

   Defina sua chave da plataforma OpenAI. Reabra o terminal após o setx no Windows.

   bash / zshCopiar

   export OPENAI_API_KEY="your-api-key"

   PowerShellCopiar

   setx OPENAI_API_KEY "your-api-key"

3. 3

   Opção B: adicione um provedor personalizado

   Declare um endpoint compatível com OpenAI no arquivo de configuração. env_key nomeia a variável de ambiente que guarda a chave; wire_api = chat serve à maioria dos endpoints de terceiros.

   ~/.codex/config.tomlCopiar

   model = "your-model-name"
   model_provider = "custom"
   
   [model_providers.custom]
   name = "Custom"
   base_url = "https://api.example.com/v1"
   env_key = "OPENAI_API_KEY"
   wire_api = "chat"

4. 4

   Limpe um login do ChatGPT salvo

   Só se você tiver entrado com o ChatGPT antes. Isso força o Codex a usar sua própria chave.

   bashCopiar

   codex logout

5. 5

   Comece a programar

   Execute dentro da pasta do seu projeto e comece a dar instruções.

   bashCopiar

   codex