BotMate
Search
⌃K

Getting started

Learn how to install BotMate on your computer.
Welcome to BotMate installation guide! This documentation will walk you through the process of installing BotMate on your computer. Before we begin, please make sure that you have Node.js installed on your machine. We recommend using Node.js version 16 or higher.
You can follow the same step to install on Termux (Android) and other Linux servers.

Step 1: Install BotMate

To install BotMate, run the following command in your terminal:
npm i -g botmate
This will install BotMate globally on your machine.

Step 2: Verify Installation

To verify that BotMate has been installed successfully, run the following command in your terminal:
botmate --version
This will display the version of BotMate that you have installed.

Step 3: Start BotMate

To start BotMate, run the following command in your terminal:
botmate init
This will prompt you to enter PostgreSQL database credentials. After you enter the details, it will save it to .env file in current working directory. Next, BotMate server will start running, the default port is 8080.
If you want to create a free PostgreSQL server, you can go with ElephantSQL.