README manual release install docs point to single-binary archives instead of package archives

Open Beginner friendly
#25,558 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
github, rust
Domain
documentation

Research direction

Start in the README's manual GitHub Release install section and compare its single-binary archive examples with the package archives and the install scripts' preferred layout. Update the documentation to point to codex-package-.tar.gz or clearly explain when to use each archive type. Done means the documented manual install matches the published release layouts.

Written by the indexing model from the issue text.

Description

CLI documentation
What happened?

The README's manual GitHub Release install section tells users to download single-binary archives such as:

  • codex-aarch64-apple-darwin.tar.gz
  • codex-x86_64-apple-darwin.tar.gz
  • codex-x86_64-unknown-linux-musl.tar.gz
  • codex-aarch64-unknown-linux-musl.tar.gz

and then rename the extracted binary to codex.

Current releases also publish codex-package-<target>.tar.gz archives, and the install scripts prefer the package layout. The package archives include the expected directory layout such as bin/codex, vendored tools/resources, and package metadata, while the README points users to the older single-binary layout.

Expected behavior

The manual release install docs should either point users to the canonical codex-package-<target>.tar.gz archives or explain when users should choose the single-binary archives versus the package archives.

Additional context

I searched open issues and PRs for terms including README manual GitHub Release install, codex-package, archive install, and single-binary archives, and did not find an existing open item that appears to cover this docs mismatch.

Dominant language
Rust
Stars
125k
Forks
19.5k
Avg merge
1m
Merged PRs (30d)
1k

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openai/codex

All issues in openai/codex

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.