Install Hexabot CLI and Create Your First AI Workflow Project
Getting started with a new automation platform should not take hours.
In this tutorial, I’ll show you how to install the Hexabot CLI, create a new project from the starter template, and run it locally.
This is the fastest way to start experimenting with Hexabot and build your first AI workflow project.
Watch the full video here: https://www.youtube.com/watch?v=EWVST74fQkg
What is Hexabot?
Hexabot is an AI workflow automation platform designed for building workflows, actions, agents, and conversational channels in one runtime.
You can use it to create automations that connect conversations to real actions, integrate with external services, and build AI-powered assistants that are more controlled, observable, and extensible.
Instead of starting from a large monorepo or manually wiring everything yourself, the Hexabot CLI helps you generate a clean project workspace and start building faster.
Prerequisites
Before installing Hexabot, make sure you have:
- Node.js installed
- npm or another package manager
- A terminal
- Docker, if you want to run Docker-based services locally
If you do not have Node.js installed yet, I recommend using NVM so you can easily manage Node.js versions.
Node.js with NVM guide:
https://docs.hexabot.ai/developer-guide/setup-node.js-with-nvm
You can quickly check your local setup with:
node --version
npm --version
1. Install the Hexabot CLI
Install the Hexabot CLI globally:
npm install -g @hexabot-ai/cli
Once installed, check that the CLI is available:
hexabot --help
You can also use the CLI without installing it globally:
npx @hexabot-ai/cli --help
2. Create a New Hexabot Project
Now create your first project:
hexabot create my-project
The CLI will scaffold a new Hexabot project and guide you through the initial setup.
You may be asked to provide initial admin account details such as:
- First name
- Last name
- Email
- Password
These credentials will be used to access your local Hexabot admin interface.
3. Move Into the Project Folder
Once the project is created, move into the new workspace:
cd my-project
At this point, you have a generated Hexabot project ready to run locally.
4. Start the Local Development Server
Run the project with:
hexabot dev
This starts your local Hexabot development environment.
Once the app is running, you can open the admin interface in your browser:
http://localhost:3000
You may also find the local API and API documentation at:
http://localhost:3000/api
http://localhost:3000/docs
Useful CLI Commands
Here are a few commands you will probably use often:
hexabot create <project-name>
Create a new Hexabot project.
hexabot dev
Run the project locally in development mode.
hexabot check
Check your local project setup.
hexabot migrate
Run database migrations when needed.
For the full CLI reference, check the official documentation:
https://docs.hexabot.ai/developer-guide/cli-command-reference
Common Issues
hexabot: command not found
This usually means the CLI was not installed globally or your npm global path is not available in your terminal.
You can try:
npx @hexabot-ai/cli --help
Or reinstall the CLI:
npm install -g @hexabot-ai/cli
Wrong Node.js version
Use NVM to install and switch Node.js versions:
nvm install 20
nvm use 20
Then check:
node --version
Port already in use
If the app cannot start because a port is already being used, stop the process using that port or update your local configuration.
What to Do Next
Once your project is running, the next step is to create your first workflow.
You can start here:
https://docs.hexabot.ai/quickstart/create-your-1st-workflow
You can also explore the installation guide:
https://docs.hexabot.ai/quickstart/installation
Useful Links
Hexabot Website:
https://hexabot.ai
Documentation:
https://docs.hexabot.ai
Installation Guide:
https://docs.hexabot.ai/quickstart/installation
Setup Node.js with NVM:
https://docs.hexabot.ai/developer-guide/setup-node.js-with-nvm
CLI Command Reference:
https://docs.hexabot.ai/developer-guide/cli-command-reference
Create Your First Workflow:
https://docs.hexabot.ai/quickstart/create-your-1st-workflow
GitHub Repository:
https://github.com/hexabot-ai/hexabot
Community Forum:
https://community.hexabot.ai
YouTube Channel:
https://www.youtube.com/@hexabot-videos
Final Thoughts
The Hexabot CLI is the easiest way to start building with Hexabot.
In just a few commands, you can install the CLI, generate a new project, run it locally, and start creating AI workflows.
If you find Hexabot useful, consider giving the repository a star on GitHub:
Star the Hexabot Github Repository ⭐
It helps support the project and makes it easier for more developers to discover it.
