One-click setup


Run the script and follow the prompts to enter your token and base URL.

Method:
curl -fsSL "/sh/install-codex-vscode.sh" -o install-codex-vscode.sh && bash install-codex-vscode.sh

How to open Terminal: Press Command + Space for Spotlight, type “Terminal” and hit Enter; or Finder → Applications → Utilities → Terminal. You may also enable “New Terminal at Folder” in System Settings and use it from Finder.

Get your Token and Base URL: sign in to the Augmunt Console → “CodeX / OpenAI compatible” group → create a token and copy the API key; the Base URL is typically https://hk1.augmunt.com/v1 (use your actual environment).

The script creates or updates ~/.codex/config.toml and ~/.codex/auth.json.

Manual setup


Choose a method:
1

Check system requirements

  • Operating system: Windows 10 or 11.
  • Node.js: Version 18 or newer.
  • Network: Outbound internet access.
2
Before continuing, switch to the “CLI interactive” tab above and complete the command-line setup (Node.js plus the CodeX CLI). Come back here afterward to proceed with the VS Code steps.

Install VS Code

Download from the official site and install:

  1. Open the official site.
  2. Download the Windows installer (User Installer x64 recommended).
  3. Run the installer and follow the wizard (optionally add to PATH).
  4. Launch VS Code from the Start menu.
//st.augmunt.com/images/codex/vscode-install.png
Skip if VS Code is already installed.
3

Install the VS Code extension (openai.chatgpt)

Install from the Extensions view in VS Code (not via CLI):

  1. Open the Extensions view (Ctrl+Shift+X).
  2. Search for “openai.chatgpt”.
  3. Open the extension page and click Install.
  4. Reload or restart VS Code if prompted.
Or install from the VS Code Marketplace.
//st.augmunt.com/images/codex/vscode-extension.png
4

Issue an API token

Create an Augmunt CodeX (OpenAI compatible) token:

  1. Open the Augmunt console.
  2. Create a token in the “CodeX / OpenAI compatible” group.
  3. Copy the generated API key and store it securely.
5

Create the config directory (%USERPROFILE%\.codex)

Create the folder:

Loading markdown content...

Save the following to %USERPROFILE%\.codex\config.toml:

Loading markdown content...

Save this to %USERPROFILE%\.codex\auth.json:

Loading markdown content...
Replace YOUR_CODEX_TOKEN and https://hk1.augmunt.com/v1 with your actual values; make sure the base URL ends with <code>/v1</code>.
6

Run CodeX

Open your project in VS Code (code .) and start using the extension.
//st.augmunt.com/images/codex/vscode-usage.png