What it is
Hexabot v3 is an automation platform with first-class AI capabilities. It combines workflows, actions, and conversational channels in one runtime. Workflows are defined in YAML with typed runtime contracts, and actions define workflow behavior with schema-validated inputs, outputs and settings. Projects are generated and run through the @hexabot-ai/cli command-line tool.
Who it's for
- Developers building agentic workflows that run across multiple conversational channels
- Teams that want YAML-defined workflows with schema-validated actions
- Contributors to the Hexabot monorepo, who should use PNPM and CONTRIBUTING.md
Requirements
Requirements
- Node.js ^24.17.0
- One package manager (npm, pnpm, yarn, or bun)
- Docker (optional, for Docker-based services)
- An interactive terminal (TTY) for
hexabot create, which prompts for initial admin credentials
Setup
Install the CLI
Install the Hexabot CLI globally with npm.
bashnpm install -g @hexabot-ai/cliOr run the CLI without a global install
Use npx to invoke the CLI directly.
bashnpx @hexabot-ai/cli --helpCreate and run a project
Create a project, enter its directory and start the dev server. Default endpoints are the Admin UI at http://localhost:3000, the API at http://localhost:3000/api, and API docs (non-production) at http://localhost:3000/docs.
bashhexabot create my-project cd my-project hexabot devCreate and run with npx
Equivalent commands if you have no global install.
bashnpx @hexabot-ai/cli create my-project cd my-project npx @hexabot-ai/cli dev
Examples
Force a package manager
bashhexabot create my-project --pm npmWhat it does: hexabot create auto-detects your package manager; the --pm flag forces a specific one.
Run the CLI without installing
bashnpx @hexabot-ai/cli --helpWhat it does: Shows the CLI help output without a global install.
Start the dev environment
bashhexabot dev [--docker] [--services <list>] [-d]What it does: The documented usage form of the dev command, which can optionally use Docker-based services.
Pros & cons
Pros
- Pro:Workflows are defined in YAML with typed runtime contracts and schema-validated action inputs, outputs and settings
- Pro:Supports MCP integration points, memory definitions and multi-channel continuity
- Pro:SQLite is the default for local use, and Postgres is first-class for production via DB_TYPE and DB_* variables
- Pro:The CLI offers a scaffold-and-run flow (create, dev, start, stop, env, check, config, migrate)
Cons
- Con:Requires a recent Node.js version (^24.17.0)
- Con:
hexabot createrequires an interactive terminal (TTY), so it cannot be run in CI or non-interactive shells - Con:Licensed under FCL-1.0-ALv2 rather than a conventional open-source license, so the terms need review
Images
