Quick Start

This guide shows how to create a public key and use it to install the Capture SDK on your website.

Prerequisites

In Crikket, go to Settings -> Public Keys.

Create one public key per owned website or app surface.

Add the exact HTTP(S) origins where the widget is allowed to run, for example:

Public keys are safe to embed in client-side code.

npm install @crikket/capture

Or:

bun add @crikket/capture

Run init() in a browser entrypoint:

import { init } from "@crikket/capture"

init({
  key: "crk_your_public_key",
  host: "https://api.crikket.io",
})

This mounts the floating launcher on your page.

Confirm that:

Use one public key per website or app surface.
Include local development origins if you want to test locally.
Screen capture permission prompts are expected browser behavior.
If you self-host Crikket, replace https://api.crikket.io with your own API origin.