VibeSignal SDK

Feature intelligence for vibe coders. Track feature usage, capture user feedback, record sessions, and get AI-powered insights.

Installation

npm install vibesignal

Quick Start

import { VibeSignal } from 'vibesignal';

const vs = new VibeSignal({
  apiKey: 'vs_live_xxxxx', // Get from dashboard
});

// Track feature usage
vs.trackFeature('checkout_flow');

// Track with metadata
vs.trackFeature('search', {
  query: 'shoes',
  results: 42
});

Features

Feature Tracking

// Basic tracking
vs.trackFeature('feature_name');

// With metadata
vs.trackFeature('payment', {
  method: 'card',
  amount: 99.99
});

User Identification

// Identify users for better insights
vs.identify({
  id: 'user_123',
  email: '[email protected]',
  name: 'Jane Doe',
  plan: 'pro'
});

Feedback Collection

// Programmatic feedback
vs.captureFeedback({
  rating: 5,
  comment: 'Love this feature!',
  featureName: 'checkout_flow'
});

Feedback Widget

import { createFeedbackWidget } from 'vibesignal/feedback';

// Add a feedback button to your app
const widget = createFeedbackWidget({
  onSubmit: (feedback) => {
    vs.captureFeedback(feedback);
  },
  position: 'bottom-right',
  theme: 'auto' // 'light' | 'dark' | 'auto'
});

Session Recording (Optional)

import { createRecordingLoader } from 'vibesignal/recording';

// Lazy-load rrweb for session recording
const loader = createRecordingLoader({
  onRecordingReady: (events) => {
    vs.uploadRecording(sessionId, events);
  }
});

// Start recording (loads rrweb dynamically)
await loader.start();

Note: Session recording requires rrweb as a peer dependency:

npm install rrweb

Configuration

const vs = new VibeSignal({
  apiKey: 'vs_live_xxxxx',      // Required
  endpoint: 'https://...',       // Custom API endpoint
  flushInterval: 5000,           // Batch flush interval (ms)
  maxBatchSize: 50,              // Max events per batch
  sessionTimeout: 30 * 60000,    // Session timeout (ms)
  debug: false,                  // Enable debug logging
});

Events

The SDK automatically tracks:

• Page views - URL changes
• Sessions - User sessions with timeout
• Rage clicks - Frustrated clicking patterns
• Errors - Uncaught exceptions

Dashboard

View your data at vibesignal-dashboard.pages.dev

• Feature health scores
• Ship confidence metrics
• User feedback
• Session recordings
• Error tracking

Size

~5KB gzipped (core SDK)

License

MIT