Guides
Install
Install the Harmony Chat CLI and its toolchain.
Harmony Chat runs from a source checkout with Devbox and Bun. There is no Docker Compose stack to bring up and no external Postgres.
git clone <your-harmony-remote> harmony
cd harmony
devbox shell # or: devbox run -- <command>
bun installdevbox shell gives you the pinned toolchain — Bun, Node, and the build tools the native
dependencies need. Everything below is run inside it.
Verify
bun run harmony -- --help
bun run harmony -- healthbun run harmony -- … and harmony … are the same command; the long form works without a shell
alias.
What gets created
Everything Harmony Chat persists lives under $HARMONY_HOME, defaulting to ~/.harmony. Nothing else is
written outside the checkout and that directory.
| Path | Contents |
|---|---|
$HARMONY_HOME/data/ | PGlite database (product chat source of truth) |
$HARMONY_HOME/plugins/ | Installed plugin packages |
$HARMONY_HOME/mcp/ | MCP attach templates written for agent harnesses |
$HARMONY_HOME/run-state… | Run state for the main process and session pins |
Storage
The product default is HARMONY_STORAGE=pglite. PGlite is an embedded database — one writer, no
separate server process to run.
Next
Start the server with First run.