Adds Azure OpenAI support

[thegovind]

Summary

This PR introduces support for Azure OpenAI as a provider within the Codex CLI. Users can now configure the tool to leverage their Azure OpenAI deployments by specifying "azure" as the provider in config.json and setting the corresponding AZURE_OPENAI_API_KEY and AZURE_OPENAI_API_VERSION environment variables. This functionality is added alongside the existing provider options (OpenAI, OpenRouter, etc.).

Related to #92

Note: This PR is currently in Draft status because tests on the main branch are failing. It will be marked as ready for review once the main branch is stable and tests are passing.

---

What’s Changed

• Configuration (config.ts, providers.ts, README.md):
  • Added "azure" to the supported providers list in providers.ts, specifying its name, default base URL structure, and environment variable key (AZURE_OPENAI_API_KEY).
  • Defined the AZURE_OPENAI_API_VERSION environment variable in config.ts with a default value (2025-03-01-preview).
  • Updated README.md to:
    • Include "azure" in the list of providers.
    • Add a configuration section for Azure OpenAI, detailing the required environment variables (AZURE_OPENAI_API_KEY, AZURE_OPENAI_API_VERSION) with examples.
• Client Instantiation (terminal-chat.tsx, singlepass-cli-app.tsx, agent-loop.ts, compact-summary.ts, model-utils.ts):
  • Modified various components and utility functions where the OpenAI client is initialized.
  • Added conditional logic to check if the configured provider is "azure".
  • If the provider is Azure, the AzureOpenAI client from the openai package is instantiated, using the configured baseURL, apiKey (from AZURE_OPENAI_API_KEY), and apiVersion (from AZURE_OPENAI_API_VERSION).
  • Otherwise, the standard OpenAI client is instantiated as before.
• Dependencies:
  • Relies on the openai package's built-in support for AzureOpenAI. No new external dependencies were added specifically for this Azure implementation beyond the openai package itself.

---

How to Test

This has been tested locally and confirmed working with Azure OpenAI.

1. Configure config.json:
   Ensure your ~/.codex/config.json (or project-specific config) includes Azure and sets it as the active provider:

   {
     "providers": {
       // ... other providers
       "azure": {
         "name": "AzureOpenAI",
         "baseURL": "https://YOUR_RESOURCE_NAME.openai.azure.com", // Replace with your Azure endpoint
         "envKey": "AZURE_OPENAI_API_KEY"
       }
     },
     "provider": "azure", // Set Azure as the active provider
     "model": "o4-mini" // Use your Azure deployment name here
     // ... other config settings
   }

2. Set up Environment Variables:

   # Set the API Key for your Azure OpenAI resource
   export AZURE_OPENAI_API_KEY="your-azure-api-key-here"
   
   # Set the API Version (Optional - defaults to `2025-03-01-preview` if not set)
   # Ensure this version is supported by your Azure deployment and endpoint
   export AZURE_OPENAI_API_VERSION="2025-03-01-preview"

3. Get the Codex CLI by building from this PR branch:
   Clone your fork, checkout this branch (feat/azure-openai), navigate to codex-cli, and build:

   # cd /path/to/your/fork/codex
   git checkout feat/azure-openai # Or your branch name
   cd codex-cli
   corepack enable
   pnpm install
   pnpm build

4. Invoke Codex:
   Run the locally built CLI using node from the codex-cli directory:

   node ./dist/cli.js "Explain the purpose of this PR"

   (Alternatively, if you ran pnpm link after building, you can use codex "Explain the purpose of this PR" from anywhere).
5. Verify: Confirm that the command executes successfully and interacts with your configured Azure OpenAI deployment.

---

Tests

• Tested locally against an Azure OpenAI deployment using API Key authentication. Basic commands and interactions confirmed working.

---

Checklist

• Added Azure provider details to configuration files (providers.ts, config.ts).
• Implemented conditional AzureOpenAI client initialization based on provider setting.
• Ensured apiVersion is passed correctly to the Azure client.
• Updated README.md with Azure OpenAI setup instructions.
• Manually tested core functionality against a live Azure OpenAI endpoint.
• Add/update automated tests for the Azure code path (pending main stability).

cc @theabhinavdas @nikodem-wrona @fouad-openai @tibo-openai (adjust as needed)

---

I have read the CLA Document and I hereby sign the CLA

[doggy8088]

@thegovind Are you planning to use this PR to replace #92?

[jslitzkerttcu]

@thegovind Are you planning to use this PR to replace #92?

I believe so. Curious how this is coming along and if there’s anything the community can do to support your efforts here. Have been following this closely and am anxious to get a hold of this to compare performance with Claude Code.

[doggy8088]

@jslitzkerttcu I ran some tests. Claude Code is miles ahead; Codex didn't even come close to catching its tail lights!

[tibo-openai]

Nice thank you. Now that it is getting a bit more complicated, as part of this change, could you refactor the client instantiation so that we consistently instantiante it the same way across all the different callsites?

Concretely, extract all the

    if (config.provider?.toLowerCase() === "azure") {
      oai = new AzureOpenAI({
        apiKey: getApiKey(config.provider),
        baseURL: getBaseUrl(config.provider),
        apiVersion: AZURE_OPENAI_API_VERSION,
      });
    } else {
      oai = new OpenAI({
        apiKey: getApiKey(config.provider),
        baseURL: getBaseUrl(config.provider),
      });
    }

to a common file / function and use that one everywhere.

[thegovind]

Nice thank you. Now that it is getting a bit more complicated, as part of this change, could you refactor the client instantiation so that we consistently instantiante it the same way across all the different callsites?

Concretely, extract all the

    if (config.provider?.toLowerCase() === "azure") {

      oai = new AzureOpenAI({

        apiKey: getApiKey(config.provider),

        baseURL: getBaseUrl(config.provider),

        apiVersion: AZURE_OPENAI_API_VERSION,

      });

    } else {

      oai = new OpenAI({

        apiKey: getApiKey(config.provider),

        baseURL: getBaseUrl(config.provider),

      });

    }

to a common file / function and use that one everywhere.

Sounds good. I'll work on this later tonight/tomorrow and update this PR

[thegovind]

Nice thank you. Now that it is getting a bit more complicated, as part of this change, could you refactor the client instantiation so that we consistently instantiante it the same way across all the different callsites?

Concretely, extract all the

    if (config.provider?.toLowerCase() === "azure") {
      oai = new AzureOpenAI({
        apiKey: getApiKey(config.provider),
        baseURL: getBaseUrl(config.provider),
        apiVersion: AZURE_OPENAI_API_VERSION,
      });
    } else {
      oai = new OpenAI({
        apiKey: getApiKey(config.provider),
        baseURL: getBaseUrl(config.provider),
      });
    }

to a common file / function and use that one everywhere.

Alright, @tibo-openai - updated this PR accordingly. Please confirm and merge.

cc @theabhinavdas @nikodem-wrona @fouad-openai

[AdithyanI]

@thegovind Thank you for pushing this! Many of us truly appreciate it. Looking forward to this being in main.

[evmin]

@parasgoyal12 Hope you will approve and merge this soon.
Thank you for reviewing.

[evmin]

@tibo-openai - is it something you could possibly help with by any chance? Would greatly appreciate

[dbroeglin]

@theabhinavdas @nikodem-wrona @fouad-openai @tibo-openai This would be awesome if merged. Really looking forward to being able to use it.

[mzagar]

@thegovind thank you for the PR!

for me using provider settings as described did not work ootb - i needed to append '/openai' to azure url, ie:

{
    "model": "MY_AZURE_MODEL",
    "provider": "azure",
    "azure": {
      "name": "AzureOpenAI",
      "baseURL": "https://MY_AZURE_RESOURCE_NAME.azure.com/openai",
      "envKey": "AZURE_OPENAI_API_KEY"
    }
}

without '/openai' in baseURL i would keep getting 404s.

when using https://MY_AZURE_RESOURCE_NAME.azure.com/openai codex api calls works as expected.

[thegovind]

@thegovind thank you for the PR!

for me using provider settings as described did not work ootb - i needed to append '/openai' to azure url, ie:

{
    "model": "MY_AZURE_MODEL",
    "provider": "azure",
    "azure": {
      "name": "AzureOpenAI",
      "baseURL": "https://MY_AZURE_RESOURCE_NAME.azure.com/openai",
      "envKey": "AZURE_OPENAI_API_KEY"
    }
}

without '/openai' in baseURL i would keep getting 404s.

when using https://MY_AZURE_RESOURCE_NAME.azure.com/openai codex api calls works as expected.

Thank you, @mzagar! That's actually what I have in my local config.json, but missed to note in Readme. Fixed it now.

[thegovind]

@fouad-openai and @jslitzkerttcu - thank you for approving the PR. Could you please merge this now?

[jslitzkerttcu]

@fouad-openai and @jslitzkerttcu - thank you for approving the PR. Could you please merge this now?

I wish I could! I was just clicking around hoping it would help push things along but I do not have write access :( @fouad-openai - it's all you! @bolinfest also merged quite a bit yesterday if it requires a second person with write access - perhaps one of you could assist here?

[fouad-openai]

sorry for delay! thought i'd merged too, making a few changes this evening then will cut a release.

thanks again @thegovind!