Website · Documentation · Extensions · Discord

Hexabot v3 is an automation platform with first-class AI capabilities, combining workflows, actions, and conversational channels in one runtime.

Quick Start

Prerequisites

• Node.js ^24.17.0
• One package manager (npm, pnpm, yarn, or bun)
• Docker (optional, for Docker-based services)

This Quick Start targets projects generated with the CLI.
If you are contributing to the Hexabot monorepo itself, use PNPM (see CONTRIBUTING.md).

1) Install the CLI

npm install -g @hexabot-ai/cli

Or run the CLI without a global install:

npx @hexabot-ai/cli --help

2) Create and run a project

hexabot create my-project
cd my-project
hexabot dev

No global install? Use npx equivalents:

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

hexabot create auto-detects your package manager. You can force one with --pm, for example:

hexabot create my-project --pm npm

hexabot create prompts for initial admin credentials and requires an interactive terminal (TTY). In CI/non-interactive shells, run it from a local terminal first.

Default local endpoints:

• Admin UI: http://localhost:3000
• API: http://localhost:3000/api
• API docs (non-production): http://localhost:3000/docs

Useful CLI commands:

• hexabot create <project-name>
• hexabot dev [--docker] [--services <list>] [-d]
• hexabot start [--docker] [--services <list>] [--build] [-d]
• hexabot stop --docker [--services <list>] [-v] [--remove-orphans]
• hexabot env <init|list>
• hexabot check
• hexabot config <show|set>
• hexabot migrate [args...]

For full CLI details, see packages/cli/README.md.

Core Capabilities

• Agentic workflows: YAML workflow definitions with typed runtime contracts.
• Action-based execution: actions define workflow behavior with schema-validated inputs/outputs/settings.
• Binding system: reusable capability/config bindings separated from task logic.
• Memory support: explicit memory definitions and runtime memory integration.
• MCP integration points: Model Context Protocol support for tool/context interoperability.
• Multi-channel continuity: channels and helpers remain core concepts.
• Schema-first architecture: broad use of Zod for validation and shared contracts.

Data Layer

• TypeORM is the standard backend data layer.
• SQLite is the default local option.
• Postgres is first-class for production setups.
• Configure DB runtime using DB_TYPE and DB_* variables.

Contributing

If you want to contribute to the Hexabot monorepo (architecture, package map, PNPM workspace, Turbo tasks, CI checks), use CONTRIBUTING.md.

License

Copyright (c) 2025 Hexastack.

Licensed under FCL-1.0-ALv2. See LICENSE.md for full terms.