Skip to content
/docs/installation

Getting started

Installation

What you need, and the quickest way to a running bot.

Levix is a WhatsApp bot you run yourself. It links to your own WhatsApp account by scanning a QR code, exactly like WhatsApp Web, and everything after that is configured from a control panel in your browser.

There is no configuration file to edit. There are no keys to generate. If a guide anywhere tells you to create a .env file, it is out of date.

What you need

  • A computer or a small server that stays on. A Raspberry Pi is enough.
  • Node.js 24 or newer — pick the LTS build from nodejs.org. (Or skip Node entirely and use Docker.)
  • A phone with WhatsApp, to scan the QR once.

Levix stores everything in one file using SQLite, which Node 24 includes. Nothing is compiled, nothing else is installed, no database server is needed.

The quickest way

npm install -g levixlevix

The terminal prints the panel address, and on a desktop the browser opens by itself. Pick a password, scan the QR, done — see First run for the longer version.