Getting Started

From zero to a connected bot in a few minutes.

Requirements

Install

Core dependencies (ws, pino, libsignal, protobufjs, and more) install automatically. Optional peers: sharp, jimp, link-preview-js, audio-decode — install only what your features need (e.g. image processing).

Your first bot

import makeWASocket, {
  useMultiFileAuthState,
  makeInMemoryStore,
  DisconnectReason
} from 'aunubaileys'
import { Boom } from '@hapi/boom'

const store = makeInMemoryStore({})

async function start() {
  const { state, saveCreds } = await useMultiFileAuthState('auth')
  const sock = makeWASocket({
    auth: state,
    printQRInTerminal: true // or use a pairing code — see Connection
  })
  store.bind(sock.ev)
  sock.ev.on('creds.update', saveCreds)

  sock.ev.on('connection.update', ({ connection, lastDisconnect }) => {
    if (connection === 'close') {
      const loggedOut = (lastDisconnect?.error instanceof Boom)
        && lastDisconnect.error.output.statusCode === DisconnectReason.loggedOut
      if (!loggedOut) start() // reconnect
    }
  })

  sock.ev.on('messages.upsert', async ({ messages }) => {
    const m = messages[0]
    if (m.key.fromMe) return
    await sock.sendMessage(m.key.remoteJid, { text: 'Hello from AunuBaileys 🖤' })
  })
}
start()

Next steps