Quick Start

The fast way

Run this from your project's root directory. No account needed first — it walks you through sign up, project creation, and wiring up the SDK, all in one go:

npx roaarrr-wizard

It opens a browser tab to sign up or sign in (no password touches your terminal), detects your framework (Next.js, Vite, React, Vue, Angular, or plain HTML), installs roaarrr-browser with whatever package manager your project already uses, and writes the API key to your env file. Re-running it later is safe — it won't duplicate anything already wired up.

Already have an API key? Skip the login step:

npx roaarrr-wizard --api-key YOUR_API_KEY

Manual setup

Prefer to wire it up yourself, or the wizard couldn't detect your setup:

1. Sign up for a ROAARRR account
2. Create a new project
3. Copy your API key from the project settings

Install the ROAARRR SDK for your platform:

npm install roaarrr-browser

Then initialize it:

import { analytics } from 'roaarrr-browser';

// Initialize ROAARRR
analytics.init('YOUR_API_KEY');

// Identify known users
analytics.identify({
  identification: 'YOUR_UUID',
});

analytics.funnel('button_click', {
  buttonName: 'signup',
  page: 'homepage'
});

For detailed information about each function, see the API Reference.