fix(docs): explain removed setup commands

[elyasmnvidian]

switchyard configure --provider nvidia --target provider --no-tui

The current CLI prints:

usage: switchyard [-h] [--version] {serve,launch} ...
switchyard: error: argument command: invalid choice: 'configure' (choose from serve, launch)

configure and verify were deliberately removed when the CLI was narrowed to serve and launch, but the CLI reference only omits them. A reader cannot tell whether the commands moved or were removed.

This PR records the removal and the supported replacement: name the credential environment variable with api_key_env, export it, pass the TOML deployment to each launch, and use switchyard-server --dry-run to validate a native deployment. It does not restore saved credentials, saved deployment paths, or either removed command.

The documented replacement is:

[llm_clients.provider]
api_key_env = "PROVIDER_API_KEY"

export PROVIDER_API_KEY="your-provider-key"
switchyard launch claude --model my-route --config routes.toml
switchyard-server --config routes.toml --dry-run

How tested

• make publish from docs/ builds the site in strict mode.
• uv run pytest tests/test_cli_reference_docs.py -v -o addopts= passes all four tests. test_reference_marks_removed_setup_commands fails against main because the migration note is absent, and it also checks that the parser still excludes both removed commands.

This documentation change does not alter CLI behavior.

Summary by CodeRabbit

• Documentation

  • Documented that switchyard configure and switchyard verify are no longer available.
  • Added guidance for providing API credentials and deployment configuration on each run.
  • Documented validation through switchyard-server --dry-run.
  • Clarified that credentials and deployment paths are not persisted.

• Tests

  • Added checks to keep CLI documentation aligned with supported commands and setup guidance.

[github-actions]

PR Preview Action v1.8.1
🚀 View preview at https://NVIDIA-NeMo.github.io/Switchyard/pr-preview/pr-297/
Built to branch gh-pages at 2026-08-05 15:29 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[ayushag-nv]

lgtm

[coderabbitai]

Walkthrough

The CLI reference now documents removed setup commands, required credential and deployment handling, and dry-run validation. Tests verify documentation ordering, required statements, and the absence of configure and verify from the parser.

Changes

CLI reference updates

Layer / File(s)	Summary
Document and validate removed setup commands docs/cli_reference.md, tests/test_cli_reference_docs.py	The reference documents credential export, explicit native TOML deployments, non-persistence, and dry-run validation. Tests enforce section ordering and confirm configure and verify are absent from the parser.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

A rabbit checks the CLI with care,
“Configure” and “verify” vanish from there.
Keys are exported, paths pass through,
Dry-runs test the TOML too.
Documentation stays in view.

🚥 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 and concisely describes the documentation change for the removed setup commands.
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.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/test_cli_reference_docs.py`:
- Around line 44-52: Update test_reference_marks_removed_setup_commands to bound
the removed text between “## Removed Setup Commands” and “## Related
Documentation” before asserting its contents. Keep the existing command
availability and statement assertions, but ensure they only inspect the
removed-command section.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d79ff51f-4add-40f9-9ea9-15605879d571

📥 Commits

Reviewing files that changed from the base of the PR and between c1c1b41 and e97775e.

📒 Files selected for processing (2)

• docs/cli_reference.md
• tests/test_cli_reference_docs.py