From 502cdfdbfb97dbef0daeb9dd4ee851a4d803acfa Mon Sep 17 00:00:00 2001 From: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> Date: Mon, 6 Jul 2026 12:04:08 -0500 Subject: [PATCH 1/3] docs(cli): clarify guided plugin setup Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> --- docs/nemo-relay-cli/basic-usage.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/nemo-relay-cli/basic-usage.mdx b/docs/nemo-relay-cli/basic-usage.mdx index 171bf3cd2..a759c2149 100644 --- a/docs/nemo-relay-cli/basic-usage.mdx +++ b/docs/nemo-relay-cli/basic-usage.mdx @@ -169,6 +169,15 @@ enabled = true endpoint = "http://127.0.0.1:4318/v1/traces" ``` +After `nemo-relay config` saves the base configuration, the setup wizard asks +whether to configure plugins. Accept the default to open the plugin editor. +Answer `n` or interrupt the prompt to skip plugin setup; the base configuration +remains saved. + +To configure plugins later, run `nemo-relay plugins edit` for the user file or +`nemo-relay plugins edit --project` for `.nemo-relay/plugins.toml`. If the plugin +editor is canceled or does not complete, the base configuration remains saved. + ## Add Model Pricing for Cost Estimates Model pricing is configured with the same `plugins.toml` discovery path as From 0f9588f2b1f58645a076d30ee20b2649423dbfc8 Mon Sep 17 00:00:00 2001 From: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> Date: Mon, 6 Jul 2026 12:11:42 -0500 Subject: [PATCH 2/3] docs(cli): place plugin handoff with shared config Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> --- docs/nemo-relay-cli/basic-usage.mdx | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/nemo-relay-cli/basic-usage.mdx b/docs/nemo-relay-cli/basic-usage.mdx index a759c2149..8fd86f2c4 100644 --- a/docs/nemo-relay-cli/basic-usage.mdx +++ b/docs/nemo-relay-cli/basic-usage.mdx @@ -149,6 +149,19 @@ command = "codex" command = "hermes" ``` +### Continue to Plugin Configuration + +`nemo-relay config` saves the base Relay configuration before it asks whether +to configure plugins. Accept the default to open the plugin editor. Project and +`both` setup target `.nemo-relay/plugins.toml`; global setup targets the user +plugin file. + +Answer `n` or interrupt the prompt to stop after base setup. The saved base +configuration is not rolled back. To configure plugins later, run +`nemo-relay plugins edit` for the user file or +`nemo-relay plugins edit --project` for the project file. If the plugin editor +is canceled or does not complete, the base configuration remains saved. + Observability exporters are configured in `plugins.toml`. Use `nemo-relay plugins edit` for the user file, `nemo-relay plugins edit --project` for `.nemo-relay/plugins.toml`, or write the plugin config directly: @@ -169,15 +182,6 @@ enabled = true endpoint = "http://127.0.0.1:4318/v1/traces" ``` -After `nemo-relay config` saves the base configuration, the setup wizard asks -whether to configure plugins. Accept the default to open the plugin editor. -Answer `n` or interrupt the prompt to skip plugin setup; the base configuration -remains saved. - -To configure plugins later, run `nemo-relay plugins edit` for the user file or -`nemo-relay plugins edit --project` for `.nemo-relay/plugins.toml`. If the plugin -editor is canceled or does not complete, the base configuration remains saved. - ## Add Model Pricing for Cost Estimates Model pricing is configured with the same `plugins.toml` discovery path as From 94156964ab9b1374762bb81ce92d35bbce17a3c3 Mon Sep 17 00:00:00 2001 From: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> Date: Mon, 6 Jul 2026 12:38:54 -0500 Subject: [PATCH 3/3] docs(cli): explain interactive setup flow Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> --- docs/nemo-relay-cli/basic-usage.mdx | 80 ++++++++--------------------- 1 file changed, 20 insertions(+), 60 deletions(-) diff --git a/docs/nemo-relay-cli/basic-usage.mdx b/docs/nemo-relay-cli/basic-usage.mdx index 8fd86f2c4..a70ed83a0 100644 --- a/docs/nemo-relay-cli/basic-usage.mdx +++ b/docs/nemo-relay-cli/basic-usage.mdx @@ -121,66 +121,26 @@ Shared TOML config is optional. The gateway loads defaults, then system config, then project config, then user config. User config takes priority over system and project config. CLI flags and environment variables override file config. -Config file locations are: - -- `/etc/nemo-relay/config.toml` -- `.nemo-relay/config.toml` -- `$XDG_CONFIG_HOME/nemo-relay/config.toml` -- `~/.config/nemo-relay/config.toml` - -Example: - -```toml -[gateway] -max_hook_payload_bytes = 20971520 -max_passthrough_body_bytes = 104857600 - -[upstream] -openai_base_url = "https://api.openai.com/v1" -anthropic_base_url = "https://api.anthropic.com" - -[agents.claude] -command = "claude" - -[agents.codex] -command = "codex" - -[agents.hermes] -command = "hermes" -``` - -### Continue to Plugin Configuration - -`nemo-relay config` saves the base Relay configuration before it asks whether -to configure plugins. Accept the default to open the plugin editor. Project and -`both` setup target `.nemo-relay/plugins.toml`; global setup targets the user -plugin file. - -Answer `n` or interrupt the prompt to stop after base setup. The saved base -configuration is not rolled back. To configure plugins later, run -`nemo-relay plugins edit` for the user file or -`nemo-relay plugins edit --project` for the project file. If the plugin editor -is canceled or does not complete, the base configuration remains saved. - -Observability exporters are configured in `plugins.toml`. Use -`nemo-relay plugins edit` for the user file, `nemo-relay plugins edit --project` -for `.nemo-relay/plugins.toml`, or write the plugin config directly: - -```toml -version = 1 - -[[components]] -kind = "observability" -enabled = true - -[components.config.atif] -enabled = true -output_directory = ".nemo-relay/atif" - -[components.config.openinference] -enabled = true -endpoint = "http://127.0.0.1:4318/v1/traces" -``` +### Interactive Setup + +Run `nemo-relay config` to set up Relay interactively: + +1. Choose whether the base configuration should apply to the current project, + your user account, or both. +2. Select the coding agents that Relay should observe. +3. Review and save the base `config.toml`. +4. Choose whether to continue to the plugin editor. + +The base `config.toml` stores the agent settings. Select **Yes** at the plugin +prompt to configure optional Relay components and save them separately in +`plugins.toml`. Project setup uses the project plugin configuration, global +setup uses the user plugin configuration, and `both` continues with the project +plugin configuration. + +Select **No** to finish after saving `config.toml`. Canceling the prompt or +leaving the plugin editor does not remove the saved base configuration. You can +open the plugin editor again later with `nemo-relay plugins edit`, or use +`nemo-relay plugins edit --project` for project configuration. ## Add Model Pricing for Cost Estimates