npm i -g @openai/codex
or brew install codex
npm i -g @openai/codex
or brew install --cask codex
Codex CLI is a coding agent from OpenAI that runs locally on your computer. @@ -24,7 +24,7 @@ npm install -g @openai/codex Alternatively, if you use Homebrew: ```shell -brew install codex +brew install --cask codex ``` Then simply run `codex` to get started: diff --git a/codex-rs/README.md b/codex-rs/README.md index 29a4e96b89a..e7dfadb7895 100644 --- a/codex-rs/README.md +++ b/codex-rs/README.md @@ -11,7 +11,7 @@ npm i -g @openai/codex codex ``` -You can also install via Homebrew (`brew install codex`) or download a platform-specific release directly from our [GitHub Releases](https://github.com/openai/codex/releases). +You can also install via Homebrew (`brew install --cask codex`) or download a platform-specific release directly from our [GitHub Releases](https://github.com/openai/codex/releases). ## Documentation quickstart diff --git a/docs/contributing.md b/docs/contributing.md index eb67f1ce591..155f9f1ebef 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -87,7 +87,7 @@ This will push the commit using the tag `rust-v${VERSION}`, which in turn kicks If everything looks good in the generated GitHub Release, uncheck the **pre-release** box so it is the latest release. -Create a PR to update [`Formula/c/codex.rb`](https://github.com/Homebrew/homebrew-core/blob/main/Formula/c/codex.rb) on Homebrew. +Create a PR to update [`Cask/c/codex.rb`](https://github.com/Homebrew/homebrew-cask/blob/main/Formula/c/codex.rb) on Homebrew. ### Security & responsible AI diff --git a/docs/release_management.md b/docs/release_management.md index d2b32645540..05148b1c932 100644 --- a/docs/release_management.md +++ b/docs/release_management.md @@ -4,7 +4,7 @@ Currently, we made Codex binaries available in three places: - GitHub Releases https://github.com/openai/codex/releases/ - `@openai/codex` on npm: https://www.npmjs.com/package/@openai/codex -- `codex` on Homebrew: https://formulae.brew.sh/formula/codex +- `codex` on Homebrew: https://formulae.brew.sh/cask/codex # Cutting a Release @@ -34,14 +34,12 @@ The GitHub Action is responsible for publishing to npm. ## Publishing to Homebrew -For Homebrew, we are properly set up with their automation system, so every few hours or so it will check our GitHub repo to see if there is a new release. When it finds one, it will put up a PR to create the equivalent Homebrew release, which entails building Codex CLI from source on various versions of macOS. +For Homebrew, we ship Codex as a cask. Homebrew's automation system checks our GitHub repo every few hours for a new release and will open a PR to update the cask with the latest binary. Inevitably, you just have to refresh this page periodically to see if the release has been picked up by their automation system: -https://github.com/Homebrew/homebrew-core/pulls?q=%3Apr+codex +https://github.com/Homebrew/homebrew-cask/pulls?q=%3Apr+codex -Once everything builds, a Homebrew admin has to approve the PR. Again, the whole process takes several hours and we don't have total control over it, but it seems to work pretty well. +For reference, our Homebrew cask lives at: -For reference, our Homebrew formula lives at: - -https://github.com/Homebrew/homebrew-core/blob/main/Formula/c/codex.rb +https://github.com/Homebrew/homebrew-cask/blob/main/Casks/c/codex.rb