Skip to content

Commit 5687372

Browse files
authored
docs: clarify Codex gateway config (NVIDIA#169)
#### Overview Clarifies the standalone Codex gateway setup so users know where to add the provider alias, when to restart Codex, and why existing local history may appear hidden after switching providers. - [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license. - [x] I searched existing issues and open pull requests, and this does not duplicate existing work. #### Details - Identifies `~/.codex/config.toml` as the file that should contain the `nemo-relay-openai` provider alias. - Adds a restart note for Codex GUI/app users and a new-process note for CLI users. - Documents that some Codex GUI/app versions scope visible history by active provider configuration, with an upstream Codex issue link for context. - Mirrors the guidance in both the Fern Codex CLI page and the coding-agent integration README. Validation: - `just docs` - commit-time pre-commit hooks, including docs markdown linkcheck #### Where should the reviewer start? Start with `docs/nemo-relay-cli/codex.mdx`, then compare the mirrored wording in `integrations/coding-agents/codex/README.md`. #### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to) - Closes RELAY-164 ## Summary by CodeRabbit * **Documentation** * Enhanced Standalone Gateway setup instructions with improved clarity on local provider configuration. * Added restart guidance for the application after saving provider configuration changes. * Clarified conversation history behavior with different provider configurations. [![Review Change Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](https://app.coderabbit.ai/change-stack/NVIDIA/NeMo-Relay/pull/169?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) Authors: - Will Killian (https://github.com/willkill07) Approvers: - David Gardner (https://github.com/dagardner-nv) URL: NVIDIA#169
1 parent e1e90b3 commit 5687372

2 files changed

Lines changed: 30 additions & 4 deletions

File tree

docs/nemo-relay-cli/codex.mdx

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ wrapper:
9797
nemo-relay --bind 127.0.0.1:4040
9898
```
9999

100-
Then configure local Codex to use a gateway provider alias instead of
101-
overriding the reserved built-in `openai` provider:
100+
Then edit `~/.codex/config.toml` and configure local Codex to use a gateway
101+
provider alias instead of overriding the reserved built-in `openai` provider:
102102

103103
```toml
104104
model_provider = "nemo-relay-openai"
@@ -111,6 +111,20 @@ requires_openai_auth = true
111111
supports_websockets = false
112112
```
113113

114+
After saving the file, restart the Codex GUI or app so it reloads the provider
115+
configuration. For CLI usage, start a new `codex` process.
116+
117+
<Warning>
118+
Some Codex GUI or app versions appear to scope visible conversation history by
119+
the active provider configuration. If existing conversations disappear after
120+
switching `model_provider` to `nemo-relay-openai`, the history has not been
121+
removed if it returns after restoring the previous provider configuration. Use
122+
this standalone provider alias only while capturing gateway telemetry, or prefer
123+
the transparent wrapper for CLI sessions. See the upstream Codex
124+
[history visibility discussion](https://github.com/openai/codex/issues/15494#issuecomment-4164170537)
125+
for context.
126+
</Warning>
127+
114128
Local Codex GUI or app sessions have the same support level only when they read
115129
the same local hook/plugin config and provider routing. Cloud tasks may still
116130
emit some lifecycle hooks, but complete LLM lifecycle capture requires model

integrations/coding-agents/codex/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ the wrapper. Start the gateway manually:
9999
nemo-relay --bind 127.0.0.1:4040
100100
```
101101

102-
Then configure local Codex to use a gateway provider alias instead of
103-
overriding the reserved built-in `openai` provider:
102+
Then edit `~/.codex/config.toml` and configure local Codex to use a gateway
103+
provider alias instead of overriding the reserved built-in `openai` provider:
104104

105105
```toml
106106
model_provider = "nemo-relay-openai"
@@ -113,6 +113,18 @@ requires_openai_auth = true
113113
supports_websockets = false
114114
```
115115

116+
After saving the file, restart the Codex GUI or app so it reloads the provider
117+
configuration. For CLI usage, start a new `codex` process.
118+
119+
Some Codex GUI or app versions appear to scope visible conversation history by
120+
the active provider configuration. If existing conversations disappear after
121+
switching `model_provider` to `nemo-relay-openai`, the history has not been
122+
removed if it returns after restoring the previous provider configuration. Use
123+
this standalone provider alias only while capturing gateway telemetry, or prefer
124+
the transparent wrapper for CLI sessions. See the upstream Codex
125+
[history visibility discussion](https://github.com/openai/codex/issues/15494#issuecomment-4164170537)
126+
for context.
127+
116128
## Verify
117129

118130
Run a Codex session that starts, uses one simple tool, and ends. Confirm that

0 commit comments

Comments
 (0)