> For the complete documentation index, see [llms.txt](https://docs.hexabot.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hexabot.ai/quickstart/installation.md).

# Installation

Get a local Hexabot project running in a few minutes.

### Prerequisites

You need:

* Node.js `^24.17.0`
* One package manager: `npm`, `pnpm`, `yarn`, or `bun`
* Docker if you want to run Docker-based services

If you manage Node.js with `nvm`, see [Setup Node.js with NVM](/developer-guide/setup-node.js-with-nvm.md).

If you use Docker for development, see [Setting Up Docker for Development and Production](/developer-guide/setting-up-docker.md).

{% hint style="info" %}
`hexabot create` prompts for your initial admin credentials. Run it from an interactive terminal.
{% endhint %}

### Install the CLI

Install the CLI globally:

```bash
npm install -g @hexabot-ai/cli
```

Or run it without a global install:

```bash
npx @hexabot-ai/cli --help
```

### Create and run a project

```bash
hexabot create my-project
cd my-project
hexabot dev
```

If you prefer `npx`, use:

```bash
npx @hexabot-ai/cli create my-project
cd my-project
npx @hexabot-ai/cli dev
```

Hexabot detects your package manager automatically. To force one, use `--pm`:

```bash
hexabot create my-project --pm npm
```

### Local endpoints

After the app starts, these endpoints are available by default:

* Admin UI: `http://localhost:3000`
* API: `http://localhost:3000/api`
* API docs: `http://localhost:3000/docs`

Use the admin credentials you created during project setup.

### Useful commands

* `hexabot create <project-name>`
* `hexabot dev [--docker --services <list>]`
* `hexabot start [--docker --services <list>]`
* `hexabot docker <up|down|logs|ps|start>`
* `hexabot env <init|list>`
* `hexabot check`
* `hexabot config <show|set>`
* `hexabot migrate [args...]`

### Notes

* SQLite is the default local database.
* Postgres is recommended for production.
* If you work on the Hexabot monorepo, use PNPM and follow the [Contributors Installation Guide](broken://spaces/12ok30OlFEEb6WoWfH8l/pages/GiKubNuo8tQcnF25GthU).

For the full command list, see [CLI Command Reference](/developer-guide/cli-command-reference.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.hexabot.ai/quickstart/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.