Skip to content

Commit 05aff64

Browse files
nshkrdotcomnshkrdotcom
authored andcommitted
add note about current cli implicit dep
1 parent 75f7ddd commit 05aff64

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,25 @@ npm install -g @openai/codex
4848
brew install codex
4949
```
5050

51-
For authentication, sign in with your ChatGPT account:
51+
The SDK does not vendor `codex-rs`; it shells out to the `codex` executable on your system. Path
52+
resolution follows this order:
53+
54+
1. `codex_path_override` supplied in `Codex.Options.new/1`
55+
2. `CODEX_PATH` environment variable
56+
3. `System.find_executable("codex")`
57+
58+
Make sure the binary at the resolved location is executable and kept up to date.
59+
60+
For authentication, sign in with your ChatGPT account (this stores credentials for the CLI):
5261

5362
```bash
5463
codex
5564
# Select "Sign in with ChatGPT"
65+
66+
Alternatively, set `CODEX_API_KEY` (or `OPENAI_API_KEY`) before starting your BEAM node and the SDK
67+
will forward it to the spawned CLI process. If neither an API key nor an authenticated CLI session
68+
is available, Codex executions will fail with upstream authentication errors—the SDK does not
69+
perform additional login flows.
5670
```
5771

5872
See the [OpenAI Codex documentation](https://github.com/openai/codex) for more authentication options.

0 commit comments

Comments
 (0)