Getting Started

Installation

bun

bun add @arnabxd/whatspurr

npm

npm install @arnabxd/whatspurr

pnpm

pnpm add @arnabxd/whatspurr

The Go bridge binary is automatically downloaded on first wa.start(). To build from source instead:

bun run build:go

Your First Bot

import { WhatsApp } from "@arnabxd/whatspurr";
import { renderUnicodeCompact } from "uqr";

const wa = new WhatsApp({
  sessionDir: "./session",
  logLevel: "info",
});

// QR code — render for scanning
wa.on("qr", (ctx) => {
  console.log("\nScan this QR code in WhatsApp:\n");
  console.log(renderUnicodeCompact(ctx.qr.code));
});

// Connected
wa.on("connected", (ctx) => {
  console.log(`Connected as ${ctx.connected.jid}`);
});

// Echo bot: reply to text messages
wa.on("message:text", async (ctx) => {
  console.log(`${ctx.from}: ${ctx.text}`);
  await ctx.reply(`Echo: ${ctx.text}`);
});

// Start
await wa.start();

// Graceful shutdown
process.on("SIGINT", async () => {
  await wa.stop();
  process.exit(0);
});

How It Works

whatspurr runs a Go sidecar process that handles the WhatsApp Web protocol via whatsmeow. Your TypeScript code communicates with it over a local WebSocket connection.

• The Go binary is started and managed automatically
• Session data is persisted in SQLite — scan QR once, stay connected
• All communication is local, no external servers involved