Switchyard lets LLM applications route traffic across models and providers while preserving native OpenAI and Anthropic API compatibility - enabling flexible model selection, benchmarking, and cost/performance optimization.
Rust
fix(docs): explain removed setup commands (#297)
Elyas Mehtabuddin016a51112868
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 63195a865..ee3e55528 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -22,6 +22,12 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).Catalog auto-discovery via a bare `type: passthrough` route is gone; there isno `type: model` equivalent, so list the model ids you want as explicit`type: model` routes.+- **`switchyard configure` and `switchyard verify` CLI commands** — removed when+ the CLI was narrowed to `serve` and `launch`. Switchyard no longer saves+ provider credentials or deployment paths. Name the credential environment+ variable with `api_key_env` in a native TOML deployment, export it, and pass+ the deployment to each `switchyard launch`. Validate a deployment with+ `./target/release/switchyard-server --config <deployment.toml> --dry-run`.### Fixeddiff --git a/docs/cli_reference.md b/docs/cli_reference.mdindex e6818519e..c2f40ed81 100644--- a/docs/cli_reference.md+++ b/docs/cli_reference.md@@ -83,7 +83,27 @@ Validate a deployment, then start the proxy:--host 127.0.0.1 --port 4000```+## Removed Setup Commands++`switchyard configure` and `switchyard verify` are not available. Export the+environment variable named by `api_key_env` in the native TOML deployment,+then pass that deployment on each run. For example:++```toml+[llm_clients.provider]+api_key_env = "PROVIDER_API_KEY"+```++```bash+export PROVIDER_API_KEY="your-provider-key" # pragma: allowlist secret+switchyard launch claude --model my-route --config routes.toml+```++The CLI does not save provider credentials or deployment paths.+Use `./target/release/switchyard-server --config routes.toml --dry-run` to+validate a native deployment before starting the standalone server.+## Related Documentation-- [Getting Started](getting_started.md): installation, configuration, and verification for both paths+- [Getting Started](getting_started.md): installation, configuration, and validation for both paths- [`switchyard-server`](../crates/switchyard-server/README.md): complete TOML schema, TLS, and metricsdiff --git a/tests/test_cli_reference_docs.py b/tests/test_cli_reference_docs.pyindex e846404a9..682ade769 100644--- a/tests/test_cli_reference_docs.py+++ b/tests/test_cli_reference_docs.py@@ -34,12 +34,24 @@ def test_reference_documents_launcher_before_server() -> None:text = CLI_REFERENCE.read_text()launcher = text.index("## Launcher Path: `switchyard launch`")server = text.index("## Server Path: `switchyard-server`")+ removed = text.index("## Removed Setup Commands")related = text.index("## Related Documentation")- assert launcher < server < related+ assert launcher < server < removed < relatedassert "switchyard serve" not in text- assert "switchyard configure" not in text- assert "switchyard verify" not in text+++def test_reference_marks_removed_setup_commands() -> None:+ text = CLI_REFERENCE.read_text()+ removed_start = text.index("## Removed Setup Commands")+ related_start = text.index("## Related Documentation", removed_start)+ removed = text[removed_start:related_start]+ commands = _subparsers(_build_parser())++ assert "`switchyard configure` and `switchyard verify` are not available" in removed+ assert "api_key_env" in removed+ assert "The CLI does not save provider credentials or deployment paths" in removed+ assert {"configure", "verify"}.isdisjoint(commands)def test_reference_lists_launcher_contract() -> None: