Documentation Index
Fetch the complete documentation index at: https://docs.vibefollow.com/llms.txt
Use this file to discover all available pages before exploring further.
Install
npm install @vibefollow/sdk
The SDK is published on the public npm registry. ESM-only — import works; require does not.
Runtime support
Node.js
Cloudflare Workers
Vercel Edge
Deno
Browser
Node 20 or later. Earlier versions are not supported.import { VibeFollow } from '@vibefollow/sdk';
const vf = new VibeFollow({ apiKey: process.env.VIBEFOLLOW_API_KEY! });
Works with the nodejs_compat flag enabled in wrangler.toml. The flag is required for webhook verification (uses node:crypto); the rest of the SDK works without it.compatibility_date = "2026-05-17"
compatibility_flags = ["nodejs_compat"]
import { VibeFollow } from '@vibefollow/sdk';
export default {
async fetch(req: Request, env: Env) {
const vf = new VibeFollow({ apiKey: env.VIBEFOLLOW_API_KEY });
await vf.users.signedUp('usr_42');
return new Response('ok');
},
};
Same story as Workers — the core API works on pure Edge, but webhook verification needs the Node runtime. Use the Node runtime for any route that calls vf.webhooks.constructEvent():export const runtime = 'nodejs'; // not 'edge'
deno run --allow-net --allow-env app.ts
import { VibeFollow } from 'npm:@vibefollow/sdk';
const vf = new VibeFollow({ apiKey: Deno.env.get('VIBEFOLLOW_API_KEY')! });
Not supported. Your API key must never leave your servers. If you want to send Vibefollow events from a SPA, build a thin server-side proxy.
Verify the install
import { VibeFollow, SDK_VERSION } from '@vibefollow/sdk';
console.log('SDK version:', SDK_VERSION);
const vf = new VibeFollow({ apiKey: process.env.VIBEFOLLOW_API_KEY! });
console.log('ok');
If the import resolves and the constructor doesn’t throw, you’re good.
Bundling and tree-shaking
The SDK ships as ESM with a single entry point. Tree-shaking is supported — importing only VibeFollow and WebhookSignatureError will drop everything else from your bundle.
import { VibeFollow, WebhookSignatureError } from '@vibefollow/sdk';
Pre-releases
Beta versions are tagged on the beta dist-tag:
npm install @vibefollow/sdk@beta
Don’t use pre-releases in production. They’re for verifying upcoming changes against your own test suite.
