Skip to main content
Baileys is published to npm under the @whiskeysockets/baileys scope. You can install it with npm, yarn, pnpm, or any other Node.js package manager. This page covers the stable release, the edge build straight from GitHub, and the optional peer dependencies that unlock additional features.

​
Requirements

You need Node.js 20.0.0 or later. Baileys enforces this through a preinstall check — installation will fail with a clear error message if your Node.js version is too old. Verify your version before installing:

​
Install the stable release

The stable release is the recommended starting point for new projects.

​
Install the edge version

The edge build is built directly from the master branch on GitHub. It includes the latest fixes and features but carries no stability guarantee.
The Baileys repository uses Yarn 4 internally via Corepack. You are free to use npm, yarn, or any other package manager in your own project — only contributors to the Baileys repository itself need Yarn 4.

​
Import Baileys in your project

After installing, import the default export in your TypeScript or JavaScript file:
You can also import named exports alongside the default:

​
Optional peer dependencies

Baileys has several optional peer dependencies that enable additional functionality. Install only the ones you need.

​
Image and sticker thumbnails

Baileys can generate thumbnails automatically when you send image or sticker messages. Install either jimp or sharp — you do not need both.
sharp is generally faster for production workloads. jimp is a pure JavaScript implementation with no native bindings, which makes it easier to install in restricted environments. To generate rich link previews when sending URLs, install link-preview-js:

​
Video thumbnails

Thumbnail generation for video messages requires ffmpeg to be installed as a system dependency. Install it through your operating system’s package manager:

​
Audio decode

The audio-decode package is an optional peer dependency used for certain audio processing operations:

​
Summary of peer dependencies

For most projects, start without any peer dependencies. Add jimp or sharp when you need image thumbnails, and link-preview-js when you want URL previews.

​
Next steps

Quick start

Connect to WhatsApp and send your first message.

Authentication

Link your WhatsApp account with a QR code or pairing code.