whatsapp.js Framework

A high-level, discord.py-inspired framework for building WhatsApp bots easily and quickly. Built on top of whatsapp-web.js.

Features

• Zero Meta API Setup: Uses WhatsApp Web under the hood. No business registrations needed.
• Context Object (ctx): Just like discord.py, a rich context object makes replying, reacting, and fetching chat data trivial.
• Built-in Command Handler: Define commands easily without complex if/else ladders.
• Self-Message Support: Commands work even if you send them from your own phone!
• TypeScript First: Full autocomplete support.

Installation

(Note: This is a local package for now, but soon you could publish it to npm!)

npm install whatsapp-web.js qrcode-terminal

Quick Start

import { Bot } from 'whatsapp';

const bot = new Bot({ prefix: '!' });

bot.command('ping', async (ctx) => {
    await ctx.reply('Pong! 🏓');
});

bot.command('echo', async (ctx) => {
    await ctx.send(ctx.args.join(' '));
});

bot.start();

How to Run

1. Run your script using ts-node or by compiling to JS.
2. A QR code will appear in your terminal.
3. Open WhatsApp on your phone -> Linked Devices -> Link a Device.
4. Scan the QR code.
5. Send !ping in any chat (or to yourself) and watch the bot reply!