Prerequisites: - Rust version 1.88.0 or higher - Docker Desktop (for local development) - Git (for first-time Helix source cache) - If using the cloud, you will need the CLIs for deployment targets (AWS CLI, Fly CLI)
1

Quick Install

Use the official installer script to automatically download and set up the Helix CLI:
curl -sSL https://install.helix-db.com | bash
The installer will:
  • Download the latest Helix CLI binary
  • Place it in ~/.local/bin/
  • Add the directory to your PATH
  • Create necessary configuration directories
2

Create project

helix init
3

Create schema and queries

Inside the schema.hx file, create your schema.
N::User {
  INDEX name: String,
  email: String,
  created_at: Date DEFAULT NOW
}
Inside the queries.hx file, create your queries.
QUERY createUser(name: String, email: String) =>
  user <- AddN<User>({name: name, email: email})
  RETURN user

QUERY getUser(name: String) =>
  user <- N<User>({name: name})
  RETURN user
4

Build and deploy

helix push dev
5

Test connection

Create a user
curl -X POST http://localhost:6969/createUser -d '{"name": "John Doe", "email": "john.doe@example.com"}'
Get a user
curl -X POST http://localhost:6969/getUser -d '{"name": "John Doe"}'
You now have a working HelixDB instance running locally with docker! You can now start building your application on top of it.