<commit_before>---
layout: guide
---

## Prerequisites

Botpress runs on [node](https://nodejs.org) (version >= 6.1). You must also have either [npm](https://www.npmjs.com) or [yarn](https://yarnpkg.com) installed.

## Installing the CLI

Using the Botpress CLI is the easiest and recommended way of creating bots on Botpress.

```bash
# using npm
npm install -g botpress

# using yarn
yarn global add botpress
```

> **Note:**️ Make sure you install the CLI as a global dependency, with the `-g` npm flag or the `global` command using yarn.

> If you have a permission error at this stage, consider running the command as an administrator.

Once installed, make sure that Botpress is well installed. Running the following command should return the version of the CLI tool:

```bash
# long version
botpress --version

# shortcut
bp --version
```

# Creating your first bot <a class="toc" id="toc-creating-a-new-bot" href="#toc-creating-a-new-bot"></a>

Create a new directory for your new bot called `my-first-bot` then run the following command in this folder:

```bash
botpress init
```

This will ask you a couple of questions and bootstrap a new bot from the default bot template. Once that is done, you need to install the dependencies:

```bash
# using npm
npm install

# using yarn
yarn install
```

The dependencies might take a while to install the first time. If for some reason you get an error installing Botpress, please visit our [Slack channel](https://slack.botpress.io) or [open an issue](https://github.com/botpress/botpress/issues/new).

# Starting the bot <a class="toc" id="toc-starting-bot" href="#toc-starting-bot"></a>

Once the dependencies installed, you may start the bot:

```bash
# using npm
npm start

# using yarn
yarn start
```

And that's it! This will start the bot on your computer and provide you with a graphical interface at [https://localhost:3000/](https://localhost:3000/), so that you can customize and speak with your bot.

# Next steps <a class="toc" id="toc-next-steps" href="#toc-next-steps"></a>

Your bot currently doesn't do much. In the next section, we will learn the basic components of a Botpress bot, to better prepare you to create your first customized bot!<commit_msg>Fixed links<commit_after>---
layout: guide
---

## Prerequisites <a class="toc" id="prerequisites" href="#prerequisites"></a>

Botpress runs on [node](https://nodejs.org) (version >= 6.1). You must also have either [npm](https://www.npmjs.com) or [yarn](https://yarnpkg.com) installed.

## Installing the CLI <a class="toc" id="install" href="#install"></a>

Using the Botpress CLI is the easiest and recommended way of creating bots on Botpress.

```bash
# using npm
npm install -g botpress

# using yarn
yarn global add botpress
```

> **Note:**️ Make sure you install the CLI as a global dependency, with the `-g` npm flag or the `global` command using yarn.

> If you have a permission error at this stage, consider running the command as an administrator.

Once installed, make sure that Botpress is well installed. Running the following command should return the version of the CLI tool:

```bash
# long version
botpress --version

# shortcut
bp --version
```

# Creating your first bot <a class="toc" id="toc-creating-a-new-bot" href="#toc-creating-a-new-bot"></a>

Create a new directory for your new bot called `my-first-bot` then run the following command in this folder:

```bash
botpress init
```

This will ask you a couple of questions and bootstrap a new bot from the default bot template. Once that is done, you need to install the dependencies:

```bash
# using npm
npm install

# using yarn
yarn install
```

The dependencies might take a while to install the first time. If for some reason you get an error installing Botpress, please visit our [Slack channel](https://slack.botpress.io) or [open an issue](https://github.com/botpress/botpress/issues/new).

## Starting the bot <a class="toc" id="toc-starting-bot" href="#toc-starting-bot"></a>

Once the dependencies installed, you may start the bot:

```bash
# using npm
npm start

# using yarn
yarn start
```

And that's it! This will start the bot on your computer and provide you with a graphical interface at [https://localhost:3000/](https://localhost:3000/), so that you can customize and speak with your bot.

## Next steps <a class="toc" id="toc-next-steps" href="#toc-next-steps"></a>

Your bot currently doesn't do much. In the next section, we will learn the basic components of a Botpress bot, to better prepare you to create your first customized bot!
{'fraction_non_alphanumeric': 0.10833333333333334, 'fraction_numerical': 0.0043859649122807015, 'mean_word_length': 4.328271028037383, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 25, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7635912', 'n_tokens_mistral': 1402, 'n_tokens_neox': 1275, 'n_words': 616}