Skip to content

docs(cli): document guided plugin setup #359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rapids-bot merged 3 commits into from
Jul 8, 2026
+20 −47
Merged

docs(cli): document guided plugin setup #359

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
502cdfd
docs(cli): clarify guided plugin setup
ericevans-nv Jul 6, 2026
0f9588f
docs(cli): place plugin handoff with shared config
ericevans-nv Jul 6, 2026
9415696
docs(cli): explain interactive setup flow
ericevans-nv Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 20 additions & 47 deletions docs/nemo-relay-cli/basic-usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,53 +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"
```

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

Expand Down
Loading