Drop-in script tag

For static sites, server-rendered pages, or anywhere you can't run a bundler, drop in /sdk/boot.js. Cloudflare's edge evaluates your flags for the visitor and returns the answers inside the script, so one request installs a fully-populated window.shipeasy before the browser paints. There is nothing to await and no flash of default values.

Add the tag

<script>
  (function () {
    var m = document.cookie.match(/(?:^|; )__se_anon_id=([^;]*)/),
      a = m ? m[1] : crypto.randomUUID();
    if (!m)
      document.cookie =
        "__se_anon_id=" +
        a +
        ";path=/;max-age=31536000;samesite=lax" +
        (location.protocol === "https:" ? ";secure" : "");
    document.write(
      '<script src="https://cdn.shipeasy.ai/sdk/boot.js' +
        "?p=<project-id>&k=sdk_client_...&a=" +
        encodeURIComponent(a) +
        '"><\/script>',
    );
  })();
</script>

k= is your public client key (sdk_client_…) — safe to embed in HTML. p= is your project id; boot.js checks it against the key's project and returns 400 on a mismatch, so a tag assembled from two different projects' values fails loudly instead of silently serving the wrong one.

Use the global

Reads are synchronous. The data arrived with the script, so there is no ready promise to await:

<script>
  if (window.shipeasy.getFlag("new_checkout")) {
    /* show the new checkout */
  }

  window.shipeasy.getConfig("checkout_copy");
  window.shipeasy.getKillswitch("payments"); // or ("payments", "apple_pay")
  window.shipeasy.track("checkout_started", { value: 49 });
</script>

Identify the visitor

Append u= for a known user and attrs= for anything your gate rules target on — plan, cohort, tenant:

https://cdn.shipeasy.ai/sdk/boot.js?p=<project-id>&k=sdk_client_...
  &u=user-123
  &a=<anon-id>
  &attrs=%7B%22plan%22%3A%22pro%22%7D

attrs is a URL-encoded JSON object. Country and the other geo attributes are filled in at the edge automatically, so you only need to pass what we can't derive.

After a login you can re-evaluate without a page load:

await window.shipeasy.identify({ user_id: "user-123", plan: "pro" });

When to use it (and when not to)

The script tag is the browser client under a different delivery mechanism: it reads flags and configs for the identified visitor. For server-side evaluation, use the server SDK with your server key — never put a server key in a <script> tag.

One capability does not carry over: see(), our structured error reporting, needs the full client. On a script-tag page use your existing error tracking; on a bundled page, import { see } from "@shipeasy/sdk".

Already rendering on a server?

If you use one of our server SDKs, don't add this tag — emit the payload you have already evaluated. bootstrapScriptTag() renders a /sdk/runtime.js tag carrying the request's flags as data-* attributes, which costs no extra evaluation and installs the same window.shipeasy:

// Any server SDK: TypeScript, Python, Ruby, PHP, Go, Java, Kotlin
const { bootstrap } = se.getBootstrapData();

# Bundled projects: install the SDK instead of using the script tag
npm install @shipeasy/sdk