https://github.com/hexastack/hexabot-template-starter
Hexabot Project Starter Template, fork this project to create you own template then create project with `hexabot create --template=username/my-template-repo`
https://github.com/hexastack/hexabot-template-starter
agent agents ai artificial-intelligence automation-framework chatbot chatbot-framework chatbots conversational-agents conversational-ai conversational-bots large-language-model large-language-models llama llm llms ollama opensource
Last synced: about 9 hours ago
JSON representation
Hexabot Project Starter Template, fork this project to create you own template then create project with `hexabot create --template=username/my-template-repo`
- Host: GitHub
- URL: https://github.com/hexastack/hexabot-template-starter
- Owner: Hexastack
- Created: 2024-10-27T12:01:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-26T16:15:38.000Z (about 11 hours ago)
- Last Synced: 2026-04-26T17:25:23.990Z (about 9 hours ago)
- Topics: agent, agents, ai, artificial-intelligence, automation-framework, chatbot, chatbot-framework, chatbots, conversational-agents, conversational-ai, conversational-bots, large-language-model, large-language-models, llama, llm, llms, ollama, opensource
- Language: TypeScript
- Homepage: https://docs.hexabot.ai
- Size: 380 KB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hexabot Template Starter
A small launchpad for building Hexabot AI automation apps.
This template gives you a ready-to-run Nest app powered by `@hexabot-ai/api`. That dependency brings the Hexabot runtime, workflow engine, extension discovery, and built admin frontend, so this repo can stay focused on your project-specific code.
Hexabot lets you build agentic workflows across channels: conversational, manual, scheduled, tool-calling, memory-aware, or whatever your automation needs next.
## Quick Start
Requirements:
- Node.js `20.19.x`
- npm, unless you change `hexabot.config.json`
- Docker only for `hexabot ... --docker`
Install the CLI and create an app:
```sh
npm install -g @hexabot-ai/cli@alpha
npx @hexabot-ai/cli@alpha create support-bot
cd support-bot
hexabot dev
```
The CLI creates `.env`, asks for the first admin credentials, installs dependencies, and starts local development with SQLite.
If you run this template directly, edit `SEED_ADMIN_*` in `.env` before the first startup.
## What You Can Build Here
- Workflow actions with typed Zod input, output, and settings.
- Channel integrations for chat, messaging, widgets, and other entry points.
- Helper services for reusable integrations.
- Binding and memory extensions when your workflows need shared capabilities or LLM-oriented context.
- App-specific Nest modules, controllers, and services.
The starter action lives at `src/extensions/actions/dummy.action.ts`. Copy it, rename it, and make it do real work.
## Commands
| Task | Command |
| --- | --- |
| Local dev | `npm run dev` or `hexabot dev` |
| Build | `npm run build` |
| Production start | `npm run start:prod` |
| CLI start | `hexabot start` |
| Diagnostics | `hexabot check [--docker-only]` |
## Docker
```sh
hexabot dev --docker
hexabot dev --docker --services postgres
hexabot dev --docker --services redis
hexabot dev --docker --services postgres,redis
```
SQLite is the default. The Postgres overlay sets `DB_TYPE=postgres`, starts `postgres`, and exposes pgAdmin on port `9000` in dev mode.
Production-style Docker run:
```sh
hexabot start --docker --services postgres,redis --build -d
```
## Project Map
| Path | Purpose |
| --- | --- |
| `src/main.ts` | Boots the Hexabot app. |
| `src/app.module.ts` | Root module; import your app modules here. |
| `src/hello.controller.ts` | Tiny example controller. |
| `src/extensions/actions/` | Custom workflow actions and translations. |
| `src/extensions/helpers/` | Helper integrations. |
| `src/extensions/channels/` | Channel integrations. |
| `docker/` | Compose base file and optional service overlays. |
| `hexabot.config.json` | CLI scripts, env paths, package manager, and Docker config. |
## Handy CLI
```sh
hexabot env init
hexabot env init --docker
hexabot env list
hexabot config show
hexabot docker ps
hexabot docker logs api -f
```
Keep this README close to the app. Update it when your project gains new scripts, services, extensions, or deployment rules.