Skip to main content
O Codex CLI da OpenAI é um assistente de codificação por IA que roda no seu terminal. Ao definir duas variáveis de ambiente, você pode rotear as solicitações do Codex CLI através do Flatkey para usar modelos GPT, Claude, Gemini e outros modelos de texto compatíveis quando estiverem disponíveis através do Flatkey.

Pré-requisitos

  • Codex CLI instalado: npm install -g @openai/codex
  • Uma conta Flatkey com uma chave de API — obtenha uma aqui

Configuração

Defina as seguintes variáveis de ambiente antes de executar o Codex CLI:
Ou adicione-as ao seu perfil de shell (~/.bashrc, ~/.zshrc) para tornar a configuração permanente:
~/.zshrc

Configurar com o CC Switch

CC Switch é um gerenciador de configuração de desktop de terceiros para assistentes de codificação. Não é um produto Flatkey, e o Flatkey não é uma predefinição integrada. As etapas abaixo seguem a interface atual do CC Switch. O método manual acima com OPENAI_BASE_URL e OPENAI_API_KEY e o CC Switch são formas alternativas de configurar o Codex. Para um teste claro do CC Switch, remova apenas os valores obsoletos de OPENAI_BASE_URL ou OPENAI_API_KEY que apontem para outro provedor ou chave. Valores herdados pelo seu shell podem sobrepor ou entrar em conflito com o provedor que você ativa no CC Switch.

1. Instale o CC Switch

Baixe o CC Switch em ccswitch.io ou em seu repositório oficial no GitHub. Instale-o para o seu sistema operacional e, em seguida, abra o aplicativo.

2. Abra o painel de provedor do Codex

Selecione Codex no CC Switch. Isso abre o painel de provedor que controla a configuração usada por novas sessões do Codex. Abrir o painel de provedor do Codex e selecionar o botão de adicionar provedor no CC Switch

3. Adicione o Flatkey como provedor personalizado

Escolha Custom Provider e adicione um provedor com estes valores: Insira os campos atuais do provedor Flatkey no CC Switch
Trate sua chave de API como sensível. Não a inclua em capturas de tela ou em configurações de provedor exportadas ou compartilhadas. Se ela for exposta, revogue ou rotacione a chave no Flatkey e, em seguida, substitua-a no CC Switch.
O Flatkey oferece suporte nativo à Responses API. O Local Routing do CC Switch não é necessário para esta configuração, portanto, deixe-o desativado.

4. Configure o modelo

Encontre Flatkey no painel de provedor do Codex no CC Switch e clique em Edit. Para alterar o modelo usado por novas sessões do Codex, defina Default Model com um ID exato de modelo do Diretório de Modelos do Flatkey. Não use um nome de exibição nem tente adivinhar um ID. Por exemplo, você pode inserir qualquer um destes modelos de geração de texto no campo Default Model do CC Switch:
Para adicionar ou editar outros modelos no CC Switch e exibi-los no menu /model do Codex CLI, use Model Mapping:
  1. Clique em Fetch Models para carregar os modelos disponíveis no Flatkey. Se o modelo que você precisa estiver ausente, clique em Add Model.
  2. Edite o Menu Display Name do mapeamento. Este é o rótulo mostrado no menu /model.
  3. Defina Actual Request Model com o ID exato do diretório de modelos, como claude-sonnet-4-6 ou gemini-2.5-flash. O Codex envia esse ID nas solicitações, não o rótulo do menu.
O Model Mapping controla a entrada do menu /model e seu ID de solicitação correspondente. Ele não faz com que um modelo incompatível funcione com o Codex. Após alterar um mapeamento, siga as etapas abaixo para salvar o provedor e reiniciar o Codex antes que a lista de modelos atualizada entre em vigor. Depois de salvar e ativar o Flatkey, as novas sessões do Codex usam o Default Model definido no CC Switch. Para sobrescrevê-lo apenas para um único comando, passe o mesmo ID exato:
Escolha um modelo de geração de texto que esteja disponível através do Flatkey e seja compatível com o formato de solicitação do Codex. Não use modelos de imagem, áudio ou incorporação (embedding) com o Codex CLI. Após enviar uma solicitação, trate os Logs de Uso do Flatkey como a fonte definitiva do modelo realmente utilizado. Buscar ou adicionar outros modelos e configurar seus mapeamentos de modelo do Codex CLI

5. Salve e ative o Flatkey

Salve o provedor e, em seguida, ative Flatkey no painel de provedor do Codex. Confirme que o Flatkey é o provedor ativo antes de iniciar o Codex. Confirmar que o provedor Codex do Flatkey está em uso

6. Reinicie e verifique

Saia da sessão existente do Codex e finalize seu processo. Feche a janela ou aba específica do terminal que executou o Codex, e não terminais não relacionados. Abra um terminal novo que não herde valores obsoletos relevantes de OPENAI_BASE_URL ou OPENAI_API_KEY. Vá para um diretório pequeno ou vazio e inicie uma nova sessão do Codex. Digite /model, confirme que o modelo que você adicionou ou editou aparece e selecione o modelo que deseja usar. Em seguida, envie uma solicitação mínima. Verificar uma nova sessão do Codex CLI com uma resposta mínima de OK Em seguida, abra os Logs de Uso do Flatkey e confirme a solicitação real. Verifique seu modelo, tokens de entrada e saída, latência e custo.
Uma solicitação de agente pode incluir prompts de sistema, definições de ferramentas, histórico de conversa, arquivos e resultados de comandos. Use um contexto pequeno para verificações de conectividade, para que a contagem de tokens e o custo permaneçam fáceis de inspecionar.

Voltar para outro provedor

Abra o painel de provedor do Codex no CC Switch, selecione o provedor desejado e ative-o. Finalize as sessões e processos existentes do Codex, depois abra um terminal novo que não herde valores obsoletos relevantes de OPENAI_BASE_URL ou OPENAI_API_KEY. Inicie uma nova sessão.

Solução de problemas do CC Switch

Executando o Codex CLI

Depois que as variáveis de ambiente estiverem definidas, use o Codex normalmente:
ou no modo interativo:
Todas as solicitações são roteadas através do Flatkey e cobradas do seu saldo pré-pago às taxas com desconto do Flatkey.

Verificar a configuração manual das variáveis de ambiente

Esta seção se aplica apenas ao método manual com OPENAI_BASE_URL e OPENAI_API_KEY. Se você configurou o Codex com o CC Switch, siga Reinicie e verifique acima. Para o método manual, execute um comando do Codex e verifique os Logs de Uso. Você deve ver a solicitação registrada com o modelo e as contagens de tokens. Se nenhuma solicitação aparecer, confirme que ambas as variáveis estão definidas corretamente na sessão atual do shell.
Use o nível de recarga de $200 para obter a melhor taxa efetiva em uso contínuo do Codex — o bônus acumulado reduz os custos para até 50% do preço oficial do GPT.

Solucionar problemas da configuração manual das variáveis de ambiente

A tabela abaixo se aplica apenas ao método manual com OPENAI_BASE_URL e OPENAI_API_KEY. Se você configurou o Codex com o CC Switch, use Solução de problemas do CC Switch acima.