For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navegação principal
Theme

Variáveis de ambiente

Variáveis de ambiente compatíveis com o Codex

O Codex usa config.toml para armazenar configurações persistentes. Use variáveis de ambiente para substituir configurações no shell atual, fornecer segredos de automação, ajustar o comportamento do instalador ou executar diagnósticos.

Esta página lista as variáveis de ambiente públicas e estáveis que o Codex lê diretamente. A lista não inclui variáveis internas de desenvolvimento, variáveis de teste nem os nomes de variáveis que você escolhe para os segredos de cada provedor com env_key.

Diretórios principais

Variável Quem usa Padrão Descrição
CODEX_HOME CLI, extensão de IDE, app-server e instaladores ~/.codex Define o diretório raiz onde o Codex armazena seu estado, incluindo configurações, dados de autenticação, logs, sessões, Habilidades e metadados de pacotes independentes. Se você definir essa variável, o diretório já deve existir.
CODEX_SQLITE_HOME Gerenciamento de estado da CLI e do app-server CODEX_HOME Define onde o Codex armazena os dados de estado que usam SQLite. A opção de configuração sqlite_home tem precedência. O diretório de trabalho atual serve de base para resolver caminhos relativos.

Para saber mais sobre os arquivos armazenados em CODEX_HOME, consulte Locais de armazenamento da configuração e do estado. Se vários hosts Linux abrirem os mesmos bancos de dados, consulte Executar o Codex com um diretório pessoal em NFS.

Variáveis do instalador

Estas variáveis se aplicam aos scripts de instalação independente disponíveis em https://chatgpt.com/codex/install.sh e https://chatgpt.com/codex/install.ps1.

Variável Padrão Descrição
CODEX_NON_INTERACTIVE false Defina como 1, true ou yes para pular as perguntas do instalador. O instalador usará as respostas padrão. Use essa opção em instalações e atualizações por script. Evite usá-la na configuração inicial.
CODEX_INSTALL_DIR ~/.local/bin no macOS e no Linux, %LOCALAPPDATA%\Programs\OpenAI\Codex\bin no Windows Altera o diretório de instalação do comando codex disponível ao usuário. O cache dos pacotes independentes continua em CODEX_HOME/packages/standalone.

Para instalar sem intervenção do usuário, defina CODEX_NON_INTERACTIVE=1 no shell que executa o instalador baixado.

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_NON_INTERACTIVE=1 sh
$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex

Autenticação e rede

Variável Quem usa Descrição
CODEX_API_KEY Execução, revisão, SDK de TypeScript e exec-server remoto Fornece uma chave de API a um processo não interativo do Codex. Ao executar código controlado pelo repositório, defina a variável apenas no comando que precisa dela, sem estendê-la à tarefa inteira.
CODEX_ACCESS_TOKEN CLI, app-server e automações confiáveis Fornece um token de acesso do ChatGPT ou do Codex para automações confiáveis. Para manter o login entre sessões, envie o token por um pipe para codex login --with-access-token.
OPENAI_FEDERATION_RULE_ID Identidade da carga de trabalho Seleciona a regra de federação configurada para a carga de trabalho.
OPENAI_IDENTITY_TOKEN_FILE Identidade da carga de trabalho Indica o caminho absoluto do arquivo que contém o token OIDC atual ou o JWT-SVID do SPIFFE.
OPENAI_WORKLOAD_IDENTITY_CONTEXT Identidade da carga de trabalho Permite que o cliente forneça identificadores de escopo delimitado em JSON para fins de atribuição nos registros de auditoria. Não afeta a autenticação nem a autorização.
CODEX_CA_CERTIFICATE Clientes HTTPS, de login e WebSocket Indica o caminho de um conjunto de certificados de autoridades certificadoras em formato PEM para ambientes com interceptação corporativa de TLS ou certificados raiz privados. Tem precedência sobre SSL_CERT_FILE.
SSL_CERT_FILE Clientes HTTPS, de login e WebSocket Indica o caminho do conjunto de certificados de autoridades certificadoras em formato PEM usado quando CODEX_CA_CERTIFICATE não está definida.

Para usar a chave de API de um provedor, defina env_key na configuração do provedor de modelos. O Codex lê a variável indicada nessa configuração, portanto o nome dela não é fixo no Codex.

Para saber como lidar com segredos em automações, consulte Usar autenticação por chave de API. Para configurar tokens de acesso, consulte Tokens de acesso.

Diagnóstico

Variável Quem usa Descrição
RUST_LOG CLI e app-server Controla a filtragem e o nível de detalhe dos logs do Rust. Por padrão, codex exec exibe apenas mensagens de nível error, a menos que você defina um nível mais detalhado.

RUST_LOG aceita valores como error, warn, info, debug e trace. Também aceita filtros de log mais específicos do Rust, como codex_core=debug,codex_tui=debug.

Por padrão, a CLI interativa armazena os dados de diagnóstico localmente, com limite de tamanho. Para gravar esses dados no arquivo de texto simples codex-tui.log, você precisa ativar essa opção. Defina log_dir explicitamente quando precisar de um log em texto simples para investigar problemas.

RUST_LOG=debug codex -c log_dir=./.codex-log
tail -F ./.codex-log/codex-tui.log

No modo não interativo, codex exec exibe as mensagens diretamente na saída do comando, em vez de gravá-las em um arquivo de log separado da TUI.