Skip to content

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

docs: clarify proxy auth and platform validation (#741)

ryan-lempka33030fedd3c9
diff --git a/README.md b/README.md
index 2740c8c85..f94d3a077 100644
--- a/README.md
+++ b/README.md
@@ -163,6 +163,8 @@ The complete runnable version — streaming and a working client — is
You finish with a server on `localhost:4000` that any OpenAI or Anthropic client
can call. Needs [Rust with Cargo](https://rust-lang.org/tools/install/).
+For v0.3.0, the standalone server is release-validated on Ubuntu 24.04,
+Linux x86_64. Other platforms are outside the release-validation scope.
**1. Install the server.**
@@ -230,9 +232,15 @@ tokens, and routing overhead.
```bash
export ANTHROPIC_BASE_URL="http://localhost:4000"
export ANTHROPIC_MODEL="switchyard"
+export ANTHROPIC_API_KEY="placeholder" # pragma: allowlist secret
claude
```
+The placeholder satisfies Claude Code's client-side auth check. In this local
+setup, Switchyard uses the server's `OPENROUTER_API_KEY` for upstream requests.
+Do not use the placeholder with `forward_auth = true` or a gateway that requires
+a real client credential.
+
Codex CLI and other OpenAI clients use the OpenAI variables instead:
```bash
diff --git a/docs/getting_started.md b/docs/getting_started.md
index 3b5842577..389b02390 100644
--- a/docs/getting_started.md
+++ b/docs/getting_started.md
@@ -28,9 +28,11 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
```
-On macOS or native Windows, follow the
+For v0.3.0, the standalone server is release-validated on Ubuntu 24.04,
+Linux x86_64. Other platforms are outside the release-validation scope.
+
+If you try a source build on macOS or native Windows, follow the
[official Rust installation instructions](https://rust-lang.org/tools/install/).
-The Rust installer includes `rustc`, Cargo, and `rustup`.
Install `uv` for the repository's Python-based tooling and CI checks. It is not
required to build or run the Rust server: