Releaseo SDK installation

Install Releaseo with the hosted CDN script, sdk-core runtime package, or React adapter.

Choose an integration path

Path	Use it when
CDN script	You want the fastest install in a marketing site, docs site, or app shell.
`@releaseo/sdk-core`	You want a typed runtime import from your build step.
`@releaseo/react`	You are on React and want provider state, hooks, unread count, and identity sync.

Package links:

CDN script

Use the hosted script when you only need window.releaseo.

<script src="https://cdn.releaseo.io/sdk/v0/sdk.js"></script>
<script>
  window.releaseo.init({
    publishKey: "pk_live_xxx",
    theme: "auto",
    position: "right",
    locale: "en",
    debug: false,
  });
</script>

For non-blocking loading, queue calls before the script arrives.

<script>
  window.releaseo = window.releaseo || { _q: [] };
  ["init", "identify", "open", "close", "track", "on", "off"].forEach(function (method) {
    window.releaseo[method] =
      window.releaseo[method] ||
      function () {
        window.releaseo._q.push([method, [].slice.call(arguments)]);
      };
  });
</script>
<script src="https://cdn.releaseo.io/sdk/v0/sdk.js" async></script>
<script>
  window.releaseo.init({ publishKey: "pk_live_xxx" });
</script>

Runtime package

Install the core runtime when your host app imports SDK code directly.

npm install @releaseo/sdk-core

import releaseo from "@releaseo/sdk-core";

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

await releaseo.identify("u_123", {
  email: "[email protected]",
  name: "Amina",
  tenantId: "t_456",
});

await releaseo.open();

React package

Install both packages for React apps.

npm install @releaseo/sdk-core @releaseo/react

import { ReleaseoProvider } from "@releaseo/react";

export function App() {
  return (
    <ReleaseoProvider config={{ publishKey: "pk_live_xxx" }}>
      <AppShell />
    </ReleaseoProvider>
  );
}

Hosted defaults

The published SDK is built with hosted defaults for the API, widget iframe, and analytics endpoint. In production, most customers should pass only publishKey. Only pass endpoint, widgetUrl, or analyticsEndpoint for local development or self-hosted environments.

SEO note

These docs are MDX, but Astro renders them as regular HTML at build time. Search engines can discover these pages through normal links and the generated sitemap.