Skip to content

README.md

Latest commit

 

History

History
86 lines (57 loc) · 3.64 KB

README.md

File metadata and controls

86 lines (57 loc) · 3.64 KB
Raw

Switchyard

Switchyard Windows GUI

Windows tray app for NVIDIA Switchyard: a local proxy that routes LLM traffic, translates OpenAI and Anthropic APIs, and talks to cloud or local backends.

This repository is the Windows GUI (Tauri 2 + React). A release build bundles the switchyard-server routing engine next to the app. Installing the compiled GUI does not require cloning or installing the Switchyard project.

Switchyard Windows GUI dashboard

Pre-alpha. The UI and setup flow still change quickly.

Download

The latest GitHub Release is the current compiled Windows installer (NSIS .exe).

That installer is standalone: it copies Switchyard.exe and switchyard-server.exe into the install folder. You do not need Rust, Cargo, or a Switchyard checkout on the machine that runs it. The app listens at http://127.0.0.1:4000.

Windows 10/11 x64 and WebView2 are the only runtime requirements. Windows 11 usually already has WebView2; the installer can download it if missing.

Build from source (standalone installer)

Switchyard is a build dependency, not a runtime one. npm run tauri build installs switchyard-server 0.2.0 via Cargo and packs it into the NSIS installer.

Tool Notes
Windows 10/11 x64 GUI target.
Node.js 22+ and npm Frontend (apps/desktop).
Rust with Cargo Compiles the Tauri app and fetches switchyard-server from crates.io.
Visual Studio Build Tools MSVC C++ workload and Windows SDK.

You do not need a local clone of NVIDIA Switchyard. Cargo pulls the published switchyard-server crate.

cd apps\desktop
npm install
npm run tauri build

That command:

  1. Runs scripts/fetch-sidecar.mjs, which cargo installs switchyard-server 0.2.0 into src-tauri/binaries/.
  2. Builds the React UI.
  3. Produces an NSIS installer under apps/desktop/src-tauri/target/release/bundle/nsis/.

The installer is the same kind of artifact GitHub Releases publish.

Run in development

Dev builds do not bundle a real engine. tauri dev prefers switchyard-server on PATH (typically %USERPROFILE%\.cargo\bin) and ignores Tauri's empty sidecar stub.

cargo install --locked switchyard-server --version 0.2.0
cd apps\desktop
npm install
npm run tauri dev

Use a Developer PowerShell so MSVC is on PATH.

Tests

cd apps\desktop
npm test
npm run test:rust

What the app does

  • Setup wizard for cloud providers (MiniMax, OpenRouter, OpenAI, Anthropic) and local backends (Unsloth, LM Studio, Ollama/Gemma).
  • Dashboard for engine start/stop, health, and routing stats.
  • Windows tray icon, autostart, and API keys in the OS credential store.
  • Writes routes.toml and launches the bundled switchyard-server on 127.0.0.1:4000.

Engine behavior, route types, and TOML schema live in NVIDIA Switchyard docs. Copies of those docs are under docs/ for local reference.

License

The Switchyard routing engine is Apache 2.0, Copyright NVIDIA Corporation.

This desktop GUI is a separate Windows frontend that shells that engine.