Quick Start

Initialize a functional bot instance and register a fundamental command in minutes.

1. Create your project file

   Create a new file (e.g. index.ts or index.js) in your project.

2. Add the bot code

   TypeScript

     import Whatsbotcord from "whatsbotcord";
     import type { AdditionalAPI, CommandArgs, IChatContext, ICommand } from "whatsbotcord/types";
   
     const bot = new Whatsbotcord({
       commandPrefix: "!",
       tagPrefix: "@",
     });
   
    class PingCommand implements ICommand {
      name: string = "ping";
      aliases?: string[] | undefined = ["p"];
      public async run(ctx: IChatContext, api: AdditionalAPI, args: CommandArgs): Promise<void> {
        await ctx.SendText("pong!");
      }
    }
   
    bot.Commands.Add(new PingCommand());
   
    bot.Start();

   JavaScript

     import Whatsbotcord from "whatsbotcord";
     import { CreateCommand } from "whatsbotcord/helpers";
   
     const bot = new Whatsbotcord({
       commandPrefix: "!",
       tagPrefix: "@",
     });
   
     const PingCommand = CreateCommand(
       "ping",
       async function (ctx, api, args) {
         await ctx.SendText("pong!");
       }, {
         aliases: ["p"],
       }
     );
   
     bot.Commands.Add(PingCommand);
   
     bot.Start();

   Typescript/Javascript with inline command creation

    import Whatsbotcord, { BaileysAdapter, CommandType } from "whatsbotcord";
   
    const bot = new Whatsbotcord({
      commandPrefix: "!",
      tagPrefix: "@",
    }, new BaileysAdapter({
      credentialsFolder: "./auth",
      loggerMode: "recommended",
    }));
   
   bot.Commands.Add(
     {
       name: "ping",
       async run(chat, api, commandArgs) {
         await chat.SendText("pong!");
       },
     },
     CommandType.Normal
   );
   
   bot.Start();

3. Run your bot

   Node.js

   npx tsx index.ts

   Bun

   bun run index.ts

4. Scan the QR code

   A QR code will appear in your terminal. Open WhatsApp on your phone → Linked Devices → Scan the code.

Caution

That’s it!, but…

• Use responsibly this library, do not SPAM, annoy other people or anyting that can make people report you.
• Whatsapp could or could not ban you. It’s veeery rary to happen. But still, be careful.

Configuration options

The Bot constructor accepts a rich set of configuration properties. You can easily configure basic prefixes, connection throttling, error handling, interactive prompt defaults, and more. These are the most important ones:

TypeScript

import Whatsbotcord, { BaileysAdapter } from "whatsbotcord";
import type { AdditionalAPI, CommandArgs, IChatContext, ICommand } from "whatsbotcord/types";

const bot = new Whatsbotcord({
  // -------------------------------------------------------------------
  // 1. Basic Options
  // -------------------------------------------------------------------
  // Which characters should trigger a command? (Array or string)
  commandPrefix: ["!", "."],

  // Which characters should trigger a tag-based command?
  tagPrefix: ["@"],

  // Should the bot capture its own messages? (By default: false)
  ignoreSelfMessage: false,

  // This are the logs from the library by itself.
  loggerMode: "recommended"
}, new BaileysAdapter({ /** **OPTIONAL PARAM**, in case you need to configure the credentialsFolder when login with QR (Baileys.js specific behaviour)*/
  // Where to store the WhatsApp session authentication files (By default in local ./auth directory)
  credentialsFolder: "./auth",

  // Console logging detail level ("silent", "error", "debug", "recommended")
  // This are the logs, but exclusively from the BaileysAdapter. (Not related to loggerMode from 6 lines above)
  loggerMode: "recommended",
}));

class PingCommand implements ICommand {
  name: string = "ping";
  aliases?: string[] | undefined = ["p"];
  public async run(ctx: IChatContext, api: AdditionalAPI, args: CommandArgs): Promise<void> {
    await ctx.SendText("pong!");
  }
}

bot.Commands.Add(new PingCommand());
bot.Start();

JavaScript

import Whatsbotcord, { BaileysAdapter } from "whatsbotcord";

const bot = new Whatsbotcord({
  // -------------------------------------------------------------------
  // 1. Basic Options
  // -------------------------------------------------------------------
  // Which characters should trigger a command? (Array or string)
  commandPrefix: ["!", "."],

  // Which characters should trigger a tag-based command?
  tagPrefix: ["@"],

  // Should the bot capture its own messages? (By default: false)
  ignoreSelfMessage: false,
}, new BaileysAdapter({
  // Where to store the WhatsApp session authentication files (By default in local ./auth directory)
  credentialsFolder: "./auth",

  // Console logging detail level ("silent", "error", "debug", "recommended")
  loggerMode: "recommended",
}));

bot.Commands.Add({
  ...
});

bot.Start();

Tip

Yo don’t need to provide the second constructor parameter of Whatsbotcord().

🖖 (Where says => 'new "BaileysAdapter({...})"')

Is completely optional and if not provided, library by default uses Baileys.js adapter anyway.

You would need to provide in case you need to configure the loggerMode or the location of your credentialsFolder when logging with QR.

Property	Type	Default	Description
commandPrefix	string | string[]	'!'	Character(s) used to prefix commands. Configure multiple prefixes with an array (e.g. ['!', '/']).
tagPrefix	string | string[]	'@'	Character(s) used to tag the bot in messages (especially useful in group contexts).
ignoreSelfMessage	boolean	true	If true, the socket ignores messages sent by the bot itself.

Want to know what else you can config?

Check the Bot page