Reference

Quick lookup for the facts you need while deploying and integrating Sentinel.

Supported providers & intercepted routes

The gateway exposes each provider under its own path and intercepts only the text generation route below. All other routes for a provider pass through untouched.

Provider	CLI name	Client base-URL variable	Gateway path	Intercepted route
OpenAI	`openai`	`OPENAI_BASE_URL`	`/openai`	`v1/chat/completions`
Anthropic	`anthropic`	`ANTHROPIC_BASE_URL`	`/anthropic`	`v1/messages`
Gemini	`google`	`GOOGLE_GEMINI_BASE_URL`	`/gemini`	`generateContent`
Custom	(as named)	`OPENAI_BASE_URL`	`/{provider_name}`	`v1/chat/completions`

The gateway also exposes a diagnostic POST /test route. Send it a completion-style payload and it returns the same request after your guardrails run — with redactions applied, or a block reason if the request would be rejected — without forwarding it to the provider. Traffic on /test is never recorded in telemetry. The CLI wraps this route as sentinel test.

CLI commands

Command	Description
`sentinel --version`	Show the installed CLI version.
`sentinel quickstart`	Guided setup: create or connect a gateway, choose providers, and enable the proxy.
`sentinel auth`	Log in to SUPERWISE® through your browser. Add `--client-credentials` to authenticate with a Client ID and Secret instead (generate tokens).
`sentinel gateway start`	Bootstrap and run a local gateway container. `--sentinel-id` targets an existing Sentinel; `--custom-providers '<json>'` registers OpenAI-compatible backends (see Custom providers). Prints a link to the Sentinel in the SUPERWISE® app when it creates a new one.
`sentinel gateway stop`	Stop and remove the local gateway container. The Sentinel's configuration stays in the SUPERWISE® platform.
`sentinel config url`	Set the gateway URL to route traffic to.
`sentinel config providers`	Choose which providers to intercept (`openai`, `anthropic`, `google`, or `all`).
`sentinel test`	Send a test payload through the gateway's guardrails and print what would be blocked or redacted — no LLM call, and nothing recorded in telemetry.
`sentinel proxy on`	Inject the provider base-URL variables into new shell sessions.
`sentinel proxy off`	Remove the variables and restore direct-to-cloud routing.

The CLI persists its state to ~/.config/sentinel/config.json (%APPDATA%\sentinel\config.json on Windows).

Gateway container environment variables

Variable	Required	Description
`SENTINEL_ID`	Yes	The Sentinel ID registered in the SUPERWISE® platform.
`SW_CLIENT_ID`	Yes	SUPERWISE® API Client ID used to register with the control plane (generate tokens).
`SW_CLIENT_SECRET`	Yes	SUPERWISE® API Client Secret.
`CUSTOM_PROVIDERS`	No	JSON array of `{provider_name, base_url}` objects for OpenAI-compatible backends. See Custom providers.
`SENTINEL_EXTERNAL_HOST`	No	The URL where this gateway is reachable (e.g. `https://sentinel.yourcompany.com`). Reported to the control plane at startup and shown as the Gateway URL in the app's Connect dialog. If omitted, the gateway auto-detects its local IPv4 and registers `http://<ip>` (no port) — set it explicitly when running behind a load balancer or API gateway.

Gateway states

State	Meaning
`Pending`	No heartbeat received yet, or no heartbeat in the last 10 minutes.
`Active`	A heartbeat was received within the last 10 minutes (heartbeats are sent every 60 seconds).