Installation
Web SDK (React)
Section titled “Web SDK (React)”Install
Section titled “Install”@revturbine/sdk is published to the public npm registry — no auth, token, or registry configuration required.
npm install @revturbine/sdkpnpm add @revturbine/sdkyarn add @revturbine/sdkPeer Dependencies
Section titled “Peer Dependencies”The web SDK requires:
| Package | Version |
|---|---|
react | >=18.0.0 |
react-dom | >=18.0.0 |
TypeScript
Section titled “TypeScript”The SDK ships with full TypeScript declarations. No additional @types/ packages are needed.
Recommended tsconfig.json settings:
{ "compilerOptions": { "strict": true, "moduleResolution": "bundler", "esModuleInterop": true, "jsx": "react-jsx" }}Headless / Non-React
Section titled “Headless / Non-React”The same @revturbine/sdk package includes a headless entry point for use without React:
import { initRevTurbine } from '@revturbine/sdk/headless';This import tree-shakes React dependencies. See the Headless API guide for usage patterns with vanilla JS, Vue, Svelte, and Angular.
Server-Side
Section titled “Server-Side”Server SDKs are available for backend entitlement checks and placement resolution:
| Language | Package |
|---|---|
| Node.js | @revturbine/sdk (headless entry) |
| Python | revturbine (PyPI) |
The @revturbine/cli package validates and launches Playbooks from the terminal. Install it as an exact development dependency so its bundled schema snapshot is pinned with your repository:
npm install -D --save-exact @revturbine/clinpx revturbine --helpOr run it without installing:
npx @revturbine/cli validate ./revturbine.playbook.jsonAuthenticate
Section titled “Authenticate”The CLI signs in with a browser device-flow login — there are no API keys or environment variables to set. Authorize it once per machine:
revturbine loginThis opens your browser to approve the device, then stores a tenant-scoped token at ~/.revturbine/credentials.json (file mode 0600). Run revturbine status to confirm you’re connected — or revturbine signup to create an account from the terminal first. Commands that only read or validate a local file, like validate, need no login.
See the CLI reference for the full command surface, file-selector rules, generated handle types, and the draft → Release lifecycle.
Supported Runtimes
Section titled “Supported Runtimes”| Runtime | Minimum Version |
|---|---|
| Node.js | 22.13+ |
| Modern browsers | Chrome 90+, Firefox 90+, Safari 15+, Edge 90+ |
| React | 18.0+ |
| TypeScript | 5.0+ |
Next Steps
Section titled “Next Steps”- Quickstart — render your first placement
- Runtime modes — choose server, custom endpoints, or local-only