@openai/codex-sdk install docs/package metadata omit runtime CLI dependency

Open Beginner friendly
#25,533 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
node.js, typescript
Domain
developer-experience, documentation

Research direction

Inspect the TypeScript SDK README and the SDK package metadata, then trace the runtime lookup of @openai/codex/package.json. Reproduce the documented npm install followed by new Codex(); done when the package relationship is declared or the README explicitly installs @openai/codex and its optional dependencies.

Written by the indexing model from the issue text.

Description

bug CLI
What happened?

The TypeScript SDK README says to install only the SDK package:

npm install @openai/codex-sdk

The quickstart then constructs new Codex(). However, the SDK runtime resolves the CLI package with:

moduleRequire.resolve("@openai/codex/package.json")

and throws if @openai/codex and its optional platform dependencies are not installed:

Unable to locate Codex CLI binaries. Ensure @openai/codex is installed with optional dependencies.

The SDK package metadata currently has no dependencies, peerDependencies, or optionalDependencies entry for @openai/codex, so installing @openai/codex-sdk alone appears insufficient for the README quickstart.

Expected behavior

Either the SDK package should declare the required runtime CLI dependency relationship, or the README installation section should explicitly tell users to install @openai/codex alongside @openai/codex-sdk before using new Codex().

Additional context

I searched open issues and PRs for terms including Unable to locate Codex CLI binaries, @openai/codex-sdk dependency, and related install/package metadata queries, and did not find an existing open item that appears to cover this SDK install 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.