From bb30996f7c035f3a284cce8e972269f2b863e38c Mon Sep 17 00:00:00 2001 From: agro Date: Fri, 29 Aug 2025 12:40:28 +0800 Subject: [PATCH] Bugfix: Prevents `brew install codex` in comment to be executed (#2868) The default install command causes unexpected code to be executed: ``` npm install -g @openai/codex # Alternatively: `brew install codex` ``` The problem is some environment will treat # as literal string, not start of comment. Therefore the user will execute this instead (because it's in backtick) ``` brew install codex ``` And then the npm command will error (because it's trying to install package #) --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 59691b08..668a03ac 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,16 @@ ### Installing and running Codex CLI -Install globally with your preferred package manager: +Install globally with your preferred package manager. If you use npm: ```shell -npm install -g @openai/codex # Alternatively: `brew install codex` +npm install -g @openai/codex +``` + +Alternatively, if you use Homebrew: + +```shell +brew install codex ``` Then simply run `codex` to get started: