How to Install Codex CLI: A Step-by-Step Guide

When you’ve got already used Codex in ChatGPT, the Codex CLI will really feel acquainted. It brings the identical AI help immediately into your native growth surroundings, the place it could work along with your repository, shell, assessments, and different instruments.

Set up takes solely one command, however the setup selections that observe are price reviewing rigorously. On this article, you’ll discover ways to set up Codex CLI on Home windows, macOS, and Linux and full a clear first-time setup.

Earlier than You Set up

Use the standalone installer if you don’t already handle developer instruments by means of Homebrew or npm.

• Home windows: PowerShell on a supported Home windows system. WSL2 is optionally available.
• macOS or Linux: A terminal with curl out there.
• Account: A ChatGPT account or an OpenAI Platform API key.
• Workspace: A challenge folder you personal and belief.

Set up

1. Run the installer

Open a terminal. Subsequent, run the command in your working system.

macOS and Linux

curl -fsSL https://chatgpt.com/codex/set up.sh | sh

Home windows PowerShell

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/set up.ps1 | iex"

You can even run this through CMD. It executes the PowerShell command.

The Home windows installer provides Codex to your PATH; consequently, it’s prepared to be used. It additionally provides to launch the appliance.

Word: If the installer asks to begin Codex instantly, press N. Do that except the terminal is already inside a challenge folder.

Different set up strategies

Do you like a package deal supervisor? Use considered one of these choices as an alternative:

# Homebrew
brew set up --cask codex

# npm
npm set up -g @openai/codex

Equally, Homebrew is appropriate for a Brew-managed Mac setup. Use npm if Node.js already manages your world developer instruments.

First Run

2. Open a challenge folder

Transfer into the repository the place you need Codex to work. Then, launch it.

# Home windows PowerShell
cd C:Usersyoucodemy-project
codex

# macOS or Linux
cd ~/code/my-project
codex

Codex treats the present listing as its beginning workspace. By default the System32 listing could be the default one.

3. Select how you can register

The primary launch provides three sign-in routes:

• Sign up with ChatGPT: Makes use of the Codex allowance out of your ChatGPT plan.
• Sign up with Machine Code: Greatest for SSH, containers, or machines with out a browser callback.
• Present your personal API key: Utilization is billed by means of the OpenAI Platform account linked to that key.

OpenAI’s present Codex pricing web page lists Free, Go, Plus, Professional, Enterprise, Edu, and Enterprise plans. API-key utilization is billed individually. Then again, utilization in a subscription is shared between the net app and Codex.

4. Authorize Codex within the browser

If you happen to select ChatGPT, Codex prints an authentication URL. It additionally opens this URL in your browser. If the browser doesn’t open, copy and paste the URL your self.

Subsequent, register to the browser utilizing the ChatGPT account you need Codex to make use of.

Examine the account on the affirmation display screen earlier than you proceed.

Consequently, when the browser exhibits the success web page, shut the tab. Then, return to the terminal.

5. Assessment the first-run discover

Again within the terminal, Codex confirms your account. It additionally reminds you that autonomy is a alternative. Don’t ignore this discover. Press Enter after you learn it.

You may examine or change the lively boundary later. Use the /permissions command to do that.

6. Belief the best folder

Codex now prints the listing it’s about to belief. Learn the trail rigorously. Don’t simply take a look at the highlighted possibility.

Belief permits project-local configuration, hooks, and execution insurance policies to load. If the trail is flawed, give up this system. Transfer into the proper repository and run codex once more.

7. Configure the Home windows sandbox

On native Home windows, Codex could ask how you can create its sandbox. Select the default sandbox if you happen to can approve the administrator immediate.

OpenAI’s Home windows sandbox documentation calls the elevated mode the popular native setup. It makes use of lower-privilege sandbox customers. It additionally makes use of filesystem boundaries, firewall guidelines, and native coverage modifications. The non-admin mode exists for machines the place elevation is unavailable. Nonetheless, it provides weaker safety.

8. Ship a protected first immediate

As soon as the immediate seems, begin with a read-only activity. This confirms that Codex can see the repository. It doesn’t ask the device to change something.

Clarify this repository's construction. Don't change any recordsdata. Then listing the three instructions I ought to run to confirm it regionally.

Helpful Instructions After Setup

• /standing: present the mannequin, listing, account, and lively settings.
• /permissions: examine or change what Codex can learn, edit, or run.
• /mannequin: select the mannequin and reasoning effort out there to your account.
• /init: create an AGENTS.md file for repository-specific directions.
• /evaluation: evaluation modifications earlier than you commit them.
• /exit: depart the CLI cleanly.

Hold the default workspace boundary except the duty wants extra entry. The permissions documentation explains the read-only, workspace, and full-access profiles.

Updating Codex CLI

For a standalone set up, rerun the platform installer. OpenAI makes use of the identical command for set up and updates.

# macOS or Linux
curl -fsSL https://chatgpt.com/codex/set up.sh | sh

# Home windows PowerShell
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/set up.ps1 | iex"

Replace package-manager installs by means of the identical supervisor:

# Homebrew
brew improve --cask codex

# npm
npm set up -g @openai/codex@newest

End with codex --version to substantiate the put in construct.

Conclusion

Putting in Codex CLI comes down to 3 strikes:

1. An set up command
2. Single account approval
3. A workspace and sandbox determination

The one genuinely dangerous setup is the handy one within the flawed listing. Launch from the repository, maintain the sandbox boundary, examine /permissions, and start with a read-only instruction.

As soon as that’s clear, run /init and let the challenge carry its personal guidelines.

Learn extra: High 10 Expertise for Claude Code and Codex CLI