# Getting started

Welcome to MateBot installation guide! This documentation will walk you through the process of installing MateBot 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.

{% hint style="info" %}
You can follow the same step to install on **Termux** (Android) and other Linux servers.
{% endhint %}

## Step 1: Install MateBot&#x20;

To install MateBot, run the following command in your terminal:

```
npm i -g matebot
```

This will install MateBot globally on your machine.

## Step 2: Verify Installation

To verify that MateBot has been installed successfully, run the following command in your terminal:

```
matebot --version
```

This will display the version of MateBot that you have installed.

## Step 3: Start MateBot&#x20;

To start MateBot, run the following command in your terminal:

```
matebot 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, MateBot server will start running, the default port is 8080.

If you want to create a free PostgreSQL server, you can go with [ElephantSQL](https://web.archive.org/web/20230608091504/https:/elephantsql.com/).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://matebot-app.gitbook.io/untitled/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
