docs(configure): require api key in route-bundle setup

[sabhatinas]

Summary

• Clarify non-interactive route-bundle configure examples to pass explicit provider credentials.
• Document that route-bundle api_key values are used by serve/launch runtime and do not satisfy no-TTY configure.

Validation

• git diff --check -- README.md docs/getting_started.md docs/index.md docs/cli_reference.md
• uv run pytest tests/getting_started/test_getting_started.py tests/readme/test_readme.py tests/test_cli_reference_docs.py -v -o addopts=

Summary by CodeRabbit

• Documentation
  • Updated setup and CLI docs with clearer non-interactive configuration examples.
  • Added guidance for using explicit provider credentials when saving or reusing routing bundles.
  • Clarified CI-friendly usage, including required API key handling.
  • Aligned getting started and reference examples with the latest configure flow.

[github-actions]

PR Preview Action v1.8.1
🚀 View preview at https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-30/
Built to branch gh-pages at 2026-07-17 20:50 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bd81a61a-411c-4482-bde4-bd3f9c836934

📥 Commits

Reviewing files that changed from the base of the PR and between e6ce3ef and 3c45394.

📒 Files selected for processing (4)

• README.md
• docs/cli_reference.md
• docs/getting_started.md
• docs/index.md

---

Walkthrough

Documentation across README.md, docs/cli_reference.md, docs/getting_started.md, and docs/index.md is updated to replace legacy switchyard --routing-profiles routes.yaml -- configure examples with explicit non-interactive configure invocations that include --target provider, --provider, --api-key, --base-url, --no-tui, and --no-model-discovery flags, along with clarifying notes on credential sourcing.

Changes

Documentation examples for configure command

Layer / File(s)	Summary
README and index configure examples README.md, docs/index.md	Replaces legacy -- configure example with explicit provider credential and non-interactive flags, adding notes that credentials aren't read from the bundle and --api-key is required for CI.
CLI reference configure examples docs/cli_reference.md	Updates persistence and default-bundle configure examples to include explicit --target provider, provider credential flags, and non-interactive flags.
Getting started guide configure walkthrough docs/getting_started.md	Updates initial configure snippet, CI pattern instructions, and routing profiles guidance to use the non-interactive configure command with explicit provider credentials.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

Hop, hop, through docs I go,
Swapping old commands for ones that glow,
No more silent TUI guessing games,
Just --api-key and provider names,
A rabbit's cheer for clarity's sake! 🐰📄

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the docs change about non-interactive route-bundle configure now requiring an explicit API key.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

_{Comment @coderabbitai help to get the list of available commands.}

[nv-msvoboda]

@sir-merge-a-lot groom

[nv-sir-merge-a-lot]

Previous updates (collapsed)

🤖 sir-merge-a-lot

Resolving conflicts

🔄 sir-merge-a-lot is resolving conflicts on this MR.

Detected 1 conflicting file(s) (LOW). I'll update this comment with the result. This can take a couple of minutes.

---

🤖 sir-merge-a-lot

Coding agent working

🤖 sir-merge-a-lot handed a large conflict to its sandboxed coding agent.

The LLM tier could not resolve .secrets.baseline (too large or timed out), so I escalated this single file to the coding agent. I'll update this comment with the result. This can take several minutes.

---

🤖 sir-merge-a-lot

Coding agent could not resolve the conflict

⚠️ The coding agent could not resolve .secrets.baseline (reason: bounded_edit_net_new_code). This file needs manual conflict resolution. Re-invoke @sir-merge-a-lot-bot groom to try again, or resolve it by hand.

Resolution ladder trace

Rung	Result	Details
Server-side rebase	skipped	Skipped because conflicts were detected during local analysis; GitLab rebase would not produce a clean branch. Files: .secrets.baseline
Client-side rebase	skipped	Skipped because conflicts were detected during local analysis; using the conflict-resolution ladder instead of force-pushing a conflicted rebase. Files: .secrets.baseline
Rerere	miss	No cached rerere resolution matched the remaining conflicts. Files: .secrets.baseline
Mergiraf	declined	Mergiraf ran but left conflicts in the remaining files. Files: .secrets.baseline
LLM	invoked	Escalating remaining files to LLM for bounded LLM resolution. Files: .secrets.baseline
LLM	failed	LLM could not produce an accepted resolution for the remaining files. Failure reason: llm_timeout. Files: .secrets.baseline
Coding agent	failed	bounded_edit_net_new_code Files: .secrets.baseline

---

🤖 sir-merge-a-lot

Resolving conflicts

🔄 sir-merge-a-lot is resolving conflicts on this MR.

Detected 1 conflicting file(s) (REGENERATE). I'll update this comment with the result. This can take a couple of minutes.

🤖 sir-merge-a-lot

Needs regeneration

⚙️ This MR has a conflict in a generated file that I won't guess.

The file(s) below are generated from a source, so their conflicts are resolved by regenerating them — not by merging lines. I've left the branch untouched.

• .secrets.baseline — run detect-secrets scan --baseline .secrets.baseline

To finish: rebase onto main, regenerate the file(s) above, and push — or re-run @sir-merge-a-lot-bot groom after regenerating and I'll take it from there.

[nv-msvoboda]

@sir-merge-a-lot groom