Quickstart

Quickstart

Two ways to run Helio: the one-command install (recommended) or from source.

One command

curl -fsSL https://raw.githubusercontent.com/achref-soua/helio/main/install.sh | sh

This installs the helio CLI, brings up the full Docker stack, and opens the setup wizard. Pass --core for the lighter footprint (app + Postgres + Redis + Mailpit) if you don't need ClickHouse/Temporal/Redpanda/MinIO yet. Windows: use install.ps1 (PowerShell).

Then open http://localhost:3000, complete the wizard, and you have a seeded demo workspace.

From source

Requires Node ≥ 20.9, pnpm, Python 3.12, uv, and Docker + Compose.

git clone https://github.com/achref-soua/helio.git
cd helio
cp .env.example .env
task up              # full stack — or `task up:core` for the lighter profile

task up brings up the whole platform with seeded demo data. Open http://localhost:3000.

Local email is captured by Mailpit (no real mail is sent in dev) at the URL printed by task up.

Useful commands

Command	What it does
task up / task up:core	Bring up the full / core stack
task docs	Run the docs site → localhost:3002
task test	Run the test suite
task lint	Lint and type-check
task screenshots	Regenerate README screenshots from the seeded app

Full reference: the repo README and docs site.