Install dependencies

npm install

Install

Requires Node.js 18+. Chromium is downloaded automatically on install.

npm install venom-bot

<details> <summary>🧪 Nightly builds</summary>

npm install https://github.com/orkestral/venom/releases/download/nightly/venom-bot-nightly.tgz

<details> <summary>📦 Install from source</summary>

npm install github:orkestral/venom

---

Building from Source

```bash

Build individual modules

npm run build:wapi npm run build:middleware npm run build:jsQR npm run build:venom

Or build everything at once

npm run build ```

---

Quick Start

Get a fully functional bot running in under 30 seconds.

import { create } from 'venom-bot';

create({ session: 'venom-bot' }).then((client) => {

  client.onMessage(async (message) => {
    if (message.body === 'hello') {
      await client.sendText(message.from, 'Hey there! 👋 I\'m running on Venom.');
    }
  });

});

Scan the QR code that appears in your terminal. Done — you're live.

[!TIP] Sessions are saved automatically. No need to re-scan on every restart.

---

Advanced Configuration

Full control over every aspect of the browser and session.

create({
  session: 'production',

  catchQR: (base64Qr, asciiQR, attempts, urlCode) => {
    console.log(`Scan attempt ${attempts}`);
  },

  statusFind: (status, session) => {
    console.log(`[${session}] Status: ${status}`);
  },

  options: {
    // Browser
    headless: 'new',
    devtools: false,
    browserWS: '',
    browserPathExecutable: '',
    puppeteerOptions: {},
    browserArgs: [''],
    addBrowserArgs: [''],

    // Session
    folderNameToken: 'tokens',
    mkdirFolderToken: '',
    createPathFileToken: false,

    // Logging
    debug: false,
    logQR: true,
    updatesLog: true,
    disableSpins: false,
    disableWelcome: false,

    // Connection
    autoClose: 60000,
    addProxy: [''],
    userProxy: '',
    userPass: ''
  },

  browserInstance: (browser, waPage) => {
    console.log('Browser PID:', browser.process().pid);
  }
});

<details> <summary>📋 Session Status Reference</summary>

---