In case you have already used Codex in ChatGPT, the Codex CLI will really feel acquainted. It brings the identical AI help immediately into your native improvement surroundings, the place it could work along with your repository, shell, exams, and different instruments.
Set up takes just one command, however the setup decisions that comply with are price reviewing fastidiously. On this article, you’ll learn 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 non-compulsory.
macOS or Linux: A terminal with curl out there.
Account: A ChatGPT account or an OpenAI Platform API key.
Workspace: A undertaking 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 by way of CMD. It executes the PowerShell command.
The Home windows installer provides Codex to your PATH; consequently, it’s prepared to be used. It additionally presents to launch the applying.
Word: If the installer asks to begin Codex instantly, press N. Do that except the terminal is already inside a undertaking folder.
Various set up strategies
Do you favor a bundle supervisor? Use certainly 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 international developer instruments.
First Run
2. Open a undertaking 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 can be the default one.
3. Select sign up
The primary launch presents three sign-in routes:
Register with ChatGPT: Makes use of the Codex allowance out of your ChatGPT plan.
Register with Gadget 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. However, utilization in a subscription is shared between the online app and Codex.
4. Authorize Codex within the browser
In case you 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, sign up to the browser utilizing the ChatGPT account you need Codex to make use of.
Verify the account on the affirmation display screen earlier than you proceed.
Consequently, when the browser reveals the success web page, shut the tab. Then, return to the terminal.
5. Evaluate the first-run discover
Again within the terminal, Codex confirms your account. It additionally reminds you that autonomy is a selection. Don’t ignore this discover. Press Enter after you learn it.
You’ll be able to examine or change the energetic boundary later. Use the /permissions command to do that.
6. Belief the suitable folder
Codex now prints the listing it’s about to belief. Learn the trail fastidiously. 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 fallacious, give up this system. Transfer into the right repository and run codex once more.
7. Configure the Home windows sandbox
On native Home windows, Codex could ask create its sandbox. Select the default sandbox in the event you 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 adjustments. The non-admin mode exists for machines the place elevation is unavailable. Nonetheless, it presents weaker safety.
8. Ship a protected first immediate
As soon as the immediate seems, begin with a read-only process. This confirms that Codex can see the repository. It doesn’t ask the instrument to change something.
Clarify this repository’s construction. Don’t change any information. Then record the three instructions I ought to run to confirm it domestically.
Helpful Instructions After Setup
/standing: present the mannequin, listing, account, and energetic 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.
/overview: overview adjustments earlier than you commit them.
/exit: go away the CLI cleanly.
Preserve 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 verify the put in construct.
Conclusion
Putting in Codex CLI comes down to a few strikes:
An set up command
Single account approval
A workspace and sandbox resolution
The one genuinely unhealthy setup is the handy one within the fallacious listing. Launch from the repository, preserve the sandbox boundary, examine /permissions, and start with a read-only instruction.
As soon as that’s clear, run /init and let the undertaking carry its personal guidelines.
Learn extra: High 10 Abilities for Claude Code and Codex CLI
A. The CLI is free to put in. Codex is included with ChatGPT Free, Go, Plus, Professional, Enterprise, Edu, and Enterprise plans, with totally different limits. API-key utilization is billed individually.
A. No. The standalone installer doesn’t require Node.js. You want it provided that you select the npm set up methodology.
A. No. Codex runs natively on Home windows with a Home windows sandbox. WSL2 stays helpful when your repository and toolchain already stay in Linux.
A. Sure. Select ‘Present your personal API key’ throughout setup. That utilization follows OpenAI Platform billing, not your ChatGPT plan allowance.
A. Run codex login standing to examine it. Run codex logout to clear the cached credentials.
Finding out, evaluating, and explaining AI programs for over 6 years.
“𝘖𝘯𝘤𝘦 𝘮𝘦𝘯 𝘵𝘶𝘳𝘯𝘦𝘥 𝘵𝘩𝘦𝘪𝘳 𝘵𝘩𝘪𝘯𝘬𝘪𝘯𝘨 𝘰𝘷𝘦𝘳 𝘵𝘰 𝘮𝘢𝘤𝘩𝘪𝘯𝘦𝘴 𝘪𝘯 𝘵𝘩𝘦 𝘩𝘰𝘱𝘦 𝘵𝘩𝘢𝘵 𝘵𝘩𝘪𝘴 𝘸𝘰𝘶𝘭𝘥 𝘴𝘦𝘵 𝘵𝘩𝘦𝘮 𝘧𝘳𝘦𝘦. 𝘉𝘶𝘵 𝘵𝘩𝘢𝘵 𝘰𝘯𝘭𝘺 𝘱𝘦𝘳𝘮𝘪𝘵𝘵𝘦𝘥 𝘰𝘵𝘩𝘦𝘳 𝘮𝘦𝘯 𝘸𝘪𝘵𝘩 𝘮𝘢𝘤𝘩𝘪𝘯𝘦𝘴 𝘵𝘰 𝘦𝘯𝘴𝘭𝘢𝘷𝘦 𝘵𝘩𝘦𝘮.” — 𝖥𝗋𝖺𝗇𝗄 𝖧𝖾𝗋𝖻𝖾𝗋𝗍, 𝖣𝗎𝗇𝖾
Login to proceed studying and luxuriate in expert-curated content material.
Preserve Studying for Free
