@releaseo/sdk

Install

npm install @releaseo/sdk

Quick start

Initialize Releaseo once in browser-side application code:

import releaseo from "@releaseo/sdk";

releaseo.init({ publishKey: "pk_live_xxx" });

Use the same import for identity, product events, and widget controls:

await releaseo.identify("user_123", {
  name: "Jane Doe",
  email: "[email protected]",
});

await releaseo.track("feature_used", { feature: "analytics" });
await releaseo.open();

See the SDK API reference for every method, parameter, return value, and event.

How automatic updates work

The installed facade and its TypeScript declarations stay pinned in your package lock. When browser code first uses the SDK, the facade loads the compatible host runtime from Releaseo’s stable /sdk/v0/ CDN channel.

This split lets compatible runtime fixes arrive without asking every customer to reinstall the npm package. Upgrade @releaseo/sdk when you need new facade code, types, or a new public API contract.

React and Vue

Releaseo provides headless framework adapters. Install the adapter together with the recommended SDK facade:

npm install @releaseo/sdk @releaseo/react
# or
npm install @releaseo/sdk @releaseo/vue

Initialize through the adapter’s provider or plugin instead of calling releaseo.init() separately. Continue with the @releaseo/react guide or @releaseo/vue guide.

TypeScript and SSR

TypeScript declarations are included. Importing @releaseo/sdk is SSR-safe, but initialize it and call browser operations from client-side code. React and Vue adapters handle their runtime work from client lifecycle hooks.