openai / openai/codex

README package-manager copy buttons include descriptive comments

Open Beginner friendly
#39,676 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CLI documentation
Dominant language
Rust
Stars
125k
Forks
19.4k
PR merge metrics
PR metrics pending

Description

What is the issue?

The npm and Homebrew installation examples place their descriptive labels inside the shell code fences:

# Install using npm
npm install -g @openai/codex

GitHub's copy button therefore copies both the label and the executable command. Pasting the result does not produce a command-only snippet and may cause an error in environments where # is not treated as an interactive comment, such as a default interactive zsh configuration.

It would be clearer and safer to move the labels outside the fenced code blocks:

Using npm:

```shell
npm install -g @openai/codex
```

Using Homebrew:

```shell
brew install --cask codex
```

This keeps the rendered documentation equally clear while ensuring each copy button copies only the intended command.

Where did you find it?

https://github.com/openai/codex#installing-and-running-codex-cli

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.

Research direction

Open the repository README and inspect the “Installing and running Codex CLI” section linked in the issue. Move the npm and Homebrew labels outside their shell code fences, then verify the rendered copy buttons contain only the executable commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.