Installation

BugSpotter SDK can be installed via npm, loaded from CDN, or built from source.

npm (Recommended)

npm install @bugspotter/sdk

Or with other package managers:

pnpm add @bugspotter/sdk
yarn add @bugspotter/sdk

CDN

Add the SDK directly to your HTML — no build step required:

<script src="https://cdn.bugspotter.io/sdk/bugspotter-latest.min.js"></script>
<script>
  (async () => {
    await BugSpotter.init({
      endpoint: 'https://api.bugspotter.io',
      apiKey: 'bgs_your_api_key',
    });
  })();
</script>

ES Modules

import { BugSpotter } from '@bugspotter/sdk';

const bugspotter = await BugSpotter.init({
  endpoint: 'https://api.bugspotter.io',
  apiKey: 'bgs_your_api_key',
  showWidget: true,
});

CommonJS

const { BugSpotter } = require('@bugspotter/sdk');

const bugspotter = await BugSpotter.init({
  endpoint: 'https://api.bugspotter.io',
  apiKey: 'bgs_your_api_key',
});

Chrome Extension

For testing on any website without code changes, install the BugSpotter Chrome Extension. It works on any website with annotation tools, offline queue, and the same PII redaction as the SDK.

Requirements

• Any modern browser (Chrome, Firefox, Safari, Edge)
• Node.js 16+ (for npm install)
• Works with React, Vue, Angular, Next.js, Nuxt, vanilla JS

Next: Quick Start →