Skip to content
Developers

Install it in a minute.

One SDK for the events, one CLI for the catalog. Three steps from install to your first event.

01 / Packages

Two packages.

The SDK sends usage. The CLI reads your code and registers the catalog.

Runtime

SDK

TypeScript SDK with batching, backoff, circuit breaker, and browser persistence. Billable runtime events sent to api.eventra.dev.

npm i @eventra_dev/eventra-sdk
Build time

CLI

Static analysis via the TypeScript compiler API. init, sync, check, watch, and send. Catalog sync is non-billable and never counts as usage. Plugins for Vue, Svelte, Astro, and Angular read their templates.

npm i -D @eventra_dev/eventra-cli
02 / Quickstart

Your first event in three steps.

Install, add one line where a feature runs, then let the CLI list your features.

  1. Install

    Add the SDK to your app and the CLI as a dev dependency.

    Terminal
    npm i @eventra_dev/eventra-sdk
    npm i -D @eventra_dev/eventra-cli
  2. Track a feature

    Create the tracker once, then call track() where the feature runs.

    TypeScript
    import { Eventra } from "@eventra_dev/eventra-sdk";
    
    // create it once, when your app starts
    const tracker = new Eventra({ apiKey: "YOUR_PROJECT_API_KEY" });
    
    // call it where the feature runs
    tracker.track("export.clicked");
    
    // on a server, use tracker.withUser(userId).track("export.clicked")
  3. Scan and send your catalog

    The CLI reads your code and tells Eventra which features exist.

    Terminal
    npx eventra init   # asks for your API key, writes eventra.json
    npx eventra sync   # finds every tracker.track() call in your code
    npx eventra send   # uploads that list, so unused features show up
Open the dashboard

Using Next.js, Vue, NestJS, Cloudflare or something else? Every stack has its own example in the docs and in the examples repository.

03 / Works with

Your stack, probably.

40 stacks and tools, 19 with a runnable example in the examples repository. The rest are covered in the docs or marked as not tested.

Plugins are for the CLI scanner only. The SDK needs none and runs in browsers, Node.js and edge runtimes. Four template dialects need a plugin so the scanner can read them: Vue and Nuxt, Svelte, Astro and Angular.

Static analysis cannot see everything, for example event names computed at runtime. What the CLI does not cover, the latest test results and all examples on GitHub are public.

04 / Not yet

What it does not do.

The honest list, so you do not find out after you install.

  • Python, Go, Java and Kotlin

    There is no SDK for other languages yet, and the CLI cannot read their code. They are on the roadmap, with no date.

    Roadmap
  • Code scanning outside JavaScript

    The CLI reads TypeScript, JavaScript and JSX, and Vue, Svelte, Astro and Angular through the official plugins. Other template languages, such as Pug, are not read.

    Not supported
  • Frameworks and runtimes not tested yet

    Remix, SolidStart, Preact, Qwik, Gatsby, Koa, AdonisJS, Electron, Deno and Bun. The SDK and the CLI should work there, but we have not tested them, so there is no example.

    Not tested
  • Community CLI plugins

    Only the official @eventra_dev/cli-plugin-* packages are loaded. Third-party plugins are not supported.

    Not supported
  • Example projects for the rest

    SvelteKit, AWS Lambda, Netlify and React Native are described in the docs but have no runnable example project yet.

    In the docs
Next

Read the docs.
Then ship it.

The docs cover every command, option and framework plugin. When you are ready, create a workspace and get an API key.