Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
A CLI Codex da OpenAI é o mesmo agente de programação que alimenta o Codex do ChatGPT. Pode executar este agente de codificação inteiramente na infraestrutura Azure, mantendo os seus dados dentro dos limites de conformidade com as vantagens adicionais de segurança de nível empresarial, redes privadas, controlo de acesso baseado em funções e gestão de custos previsível. O Codex é mais do que uma conversa com o seu agente de código – é um agente de codificação assíncrono que pode ser ativado a partir do seu terminal, VS Code ou de um executor GitHub Actions. O Codex permite-lhe abrir automaticamente pull requests, ficheiros refatorizados e escrever testes com as credenciais do seu projeto Foundry e das implementações do Azure OpenAI.
Pré-requisitos
- Uma subscrição Azure - Crie uma gratuitamente
- Permissões dos colaboradores em Microsoft Foundry.
-
homebrew(macOS) ou Node.js comnpmpara instalar o CLI do Codex. Veja Descarregar e instalar Node.js e npm. - Para Windows, instale e configure o WSL2. Ver Instalar WSL.
| Requisitos | Detalhes |
|---|---|
| Sistemas operativos | macOS 12+, Ubuntu 20.04+/Debian 10+, ou Windows 11 via WSL2 |
| Git (opcional, recomendado) | 2.23+ para ajudantes de pull-requests integrados |
| RAM | Mínimo 4 GB (recomendado 8 GB) |
Implementar um modelo no Foundry
- Vai à Foundry e cria um novo projeto.
- Do catálogo de modelos, selecione um modelo de raciocínio como
gpt-5.3-codex,gpt-5.2-codex,gpt-5.1-codex-max,gpt-5.1-codex,gpt-5.1-codex-mini,gpt-5-codexgpt-5, ,gpt-5-mini, , ou .gpt-5-nano - Para implementar o modelo a partir do catálogo de modelos, selecione Use este modelo, ou, se estiver a usar o Azure OpenAI Deployments selecione o painel deploy modelo.
- Copie a URL e a Chave da API do endpoint.
Instalar a CLI do Codex
A partir do terminal, execute os seguintes comandos para instalar o Codex CLI
Criar e configurar o config.toml
Para usar o Codex CLI com Azure, é necessário criar e configurar um ficheiro
config.toml.O ficheiro config.toml precisa de ser armazenado no
~/.codexdiretório. Crie umconfig.tomlficheiro dentro deste diretório ou edite o ficheiro existente se este já existir:cd ~/.codex nano config.tomlCopie o texto abaixo para usar a API v1 Responses. Com a API v1 já não precisa fornecer a versão da API, mas deve incluir /v1 no caminho
base_url. Não pode passar a sua chave API como uma string diretamente paraenv_key.env_keydeve apontar para uma variável de ambiente. Atualize o seubase_urlcom o nome do seu recurso:model = "gpt-5-codex" # Replace with your actual Azure model deployment name model_provider = "azure" model_reasoning_effort = "medium" [model_providers.azure] name = "Azure OpenAI" base_url = "https://YOUR_RESOURCE_NAME.openai.azure.com/openai/v1" env_key = "AZURE_OPENAI_API_KEY" wire_api = "responses"Depois de guardares as atualizações do teu
config.tomlficheiro, volta ao terminal e cria uma instância da variável ambiente que está referenciada no teu ficheiro de configuração.# Linux, macOS, or WSL export AZURE_OPENAI_API_KEY="<your-api-key>"Agora execute um dos seguintes comandos no terminal para testar se a configuração do seu Codex CLI foi bem-sucedida:
Comando Finalidade Códice Iniciar a Interface Interativa de Utilizador do Terminal (TUI) códice "Prompt inicial" Lançar TUI com um prompt inicial Codex exec "Prompt inicial" Lançar o TUI em modo "automação" não interativo
Usar o Codex no Visual Studio Code
Também pode usar o Codex diretamente dentro de Visual Studio Code ao usar a extensão OpenAI Codex
Se ainda não tiveres Visual Studio Code, podes instalá-lo para macOS e Linux.
Instala a extensão OpenAI Codex. A extensão depende do teu
config.tomlficheiro que foi configurado para Codex CLI.Se estiver numa nova sessão de terminal, configure a variável de ambiente para
AZURE_OPENAI_API_KEY:export OPENAI_API_KEY="<your-azure-api-key-here>"Nota
Se usares WSL, define também a mesma variável de ambiente no host do Windows para que a extensão possa lê-la quando necessário.
Lançar o VS Code a partir da mesma sessão do Terminal. (O lançamento a partir de um iniciador de aplicações pode resultar na variável de ambiente da chave API não estar acessível para a extensão Codex.)
code .Agora poderá usar o Codex no Visual Studio Code para conversar, editar e pré-visualizar alterações enquanto alterna entre três modos de aprovação.
Modos de aprovação
Os modos de aprovação determinam quanta autonomia e interação queres ter com o Codex.
| Modo de aprovação | Descrição |
|---|---|
| Chat | Para conversar e planear com o modelo. |
| Agente | O Codex pode ler ficheiros, fazer edições e executar comandos automaticamente no diretório de trabalho. A Codex precisará de aprovação para atividades fora do diretório de trabalho ou para aceder à internet. |
| Agente (acesso total) | Todas as capacidades do modo Agente sem necessidade de aprovação passo a passo. O modo de acesso total não deve ser usado sem uma compreensão completa dos riscos potenciais, bem como a implementação de proteções adicionais, como executar num ambiente sandbox controlado. |
Importante
Recomendamos rever as orientações da OpenAI sobre segurança do Codex.
Orientação persistente com AGENTS.md
Podes dar instruções e orientações extra ao Codex usando AGENTS.md ficheiros. O Codex procura AGENTS.md ficheiros nos seguintes locais e funde-os de cima para baixo, dando-lhe contexto sobre as suas preferências pessoais, detalhes específicos do projeto e a tarefa atual:
-
~/.codex/AGENTS.md– orientação pessoal global. -
AGENTS.mdNa raiz do seu repositório – Notas de Projeto Partilhadas. -
AGENTS.mdno diretório de trabalho atual – subpastas/características específicas.
Por exemplo, para ajudar a Codex a compreender como escrever código para Foundry Agents, pode criar um AGENTS.md na raiz do seu projeto com o seguinte conteúdo, derivado da documentação do Azure AI Agents SDK:
# Instructions for working with Foundry Agents
You are an expert in the Azure AI Agents client library for Python.
## Key Concepts
- **Client Initialization**: Always start by creating an `AIProjectClient` or `AgentsClient`. The recommended way is via `AIProjectClient`.
- **Authentication**: Use `DefaultAzureCredential` from `azure.identity`.
- **Agent Creation**: Use `agents_client.create_agent()`. Key parameters are `model`, `name`, and `instructions`.
- **Tools**: Agents use tools to perform actions like file search, code interpretation, or function calls.
- To use tools, they must be passed to `create_agent` via the `tools` and `tool_resources` parameters or a `toolset`.
- Example: `file_search_tool = FileSearchTool(vector_store_ids=[...])`
- Example: `code_interpreter = CodeInterpreterTool(file_ids=[...])`
- Example: `functions = FunctionTool(user_functions)`
## Example: Creating a basic agent
\`\`\`python
import os
from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential
# 1. Create Project Client
project_client = AIProjectClient(
endpoint=os.environ["PROJECT_ENDPOINT"],
credential=DefaultAzureCredential(),
)
# 2. Get Agents Client
with project_client:
agents_client = project_client.agents
# 3. Create Agent
agent = agents_client.create_agent(
model=os.environ["MODEL_DEPLOYMENT_NAME"],
name="my-helpful-agent",
instructions="You are a helpful agent that can answer questions.",
)
print(f"Created agent with ID: {agent.id}")
\`\`\`
No exemplo anterior, os backticks no bloco de código Python são escapados para permitir uma renderização adequada. Os \'s podem ser removidos.
Experimentar com o Codex CLI
Código de lançamento com o seguinte prompt inicial:
codex "write a python script to create an Azure AI Agent with file search capabilities"
Outros testes sugeridos:
# generate a unit test for src/utils/date.ts
# refactor this agent to use the Code Interpreter tool instead
Codex no GitHub Actions
O Codex pode ser executado como parte do seu pipeline de integração contínua (CI). Guarda a tua chave API no armazenamento secreto do repositório como AZURE_OPENAI_KEY e depois adiciona uma tarefa como esta para atualizar automaticamente o teu registo de alterações antes de um lançamento:
jobs:
update_changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Update changelog via Codex
run: |
npm install -g @openai/codex
export AZURE_OPENAI_API_KEY="${{ secrets.AZURE_OPENAI_KEY }}"
codex -p azure exec --full-auto "update CHANGELOG for next release"
Resolução de problemas
| Sintoma | Solução |
|---|---|
401 Unauthorized ou 403 Forbidden |
Exporta corretamente a tua variável de ambiente AZURE_OPENAI_API_KEY. Confirme se a sua chave tem acesso a projetos/implementação. Certifica-te de que não estás a passar a API Key como uma string diretamente para env_key dentro do config.toml ficheiro. Tens de passar uma variável de ambiente válida. |
ENOTFOUND, DNS error, ou 404 Not Found |
Verifique se base_url utiliza config.toml, o nome do seu recurso, o domínio correto e contém /v1. Por exemplo, base_url = "https://<your-resource>.openai.azure.com/openai/v1". |
| A CLI ignora as definições do Azure | Abra ~/.codex/config.toml e assegure: - model_provider = "azure" está definido. - A [model_providers.azure] secção existe. - env_key = "AZURE_OPENAI_API_KEY" Corresponde ao nome da variável do teu ambiente. |
| Suporte ao Entra ID | O suporte ao Entra ID não está atualmente disponível para o Codex. |
401 Unauthorized apenas com a extensão WSL + VS Code Codex |
Ao executar o VS Code de dentro do WSL com a extensão Codex, a extensão pode verificar a variável de ambiente da chave API no host Windows local, em vez de na shell do terminal que lançou o VS Code. Para mitigar este problema, defina também a variável de ambiente no host local do Windows, depois inicie um novo terminal a partir do WSL e inicie o VS Code com code .. |