Getting started with HelixDB CLI

Install the CLI, run locally, or link a WorkOS-authenticated Cloud database

Tutorial

Local quickstart

macOS and Linux:

curl -sSL "https://install.helix-db.com" | bash

Windows PowerShell:

irm https://raw.githubusercontent.com/HelixDB/helix-db/main/crates/cli/install.ps1 | iex

Then:

mkdir my-helix-app && cd my-helix-app
helix init local
helix start dev
helix query dev --file examples/request.json
helix stop dev

Local requests use the local auth-disabled runtime. The default storage is in-memory; use --disk or an S3 storage URI when persistence is required. helix chef can automate local scaffolding and agent setup without any Cloud login.

When helix chef launches an installed agent, it uses this priority order: Claude Code → OpenAI Codex → OpenCode → Cursor Agent.

Cloud quickstart

helix auth login
helix workspace list
helix project list --workspace-id <workspace-id>
helix database list --project <project-id>

helix project link <project-id>
helix add cloud --name production --database tenant:<tenant-id>
helix query production --file examples/request.json

Cloud commands use only the rotating WorkOS session. Query execution goes through the backend broker and requires an independent database.query.read or database.query.write grant. The CLI does not need a gateway URL, application key, service credential, or sync step.

If a command cannot derive one target, pass an explicit workspace/project or cluster:<id> / tenant:<id>. Stable links live only in the current project’s helix.toml.

Local workflow

Run and query a local instance

Cloud workflow

Use the session-authenticated Cloud CLI

Command reference

See every retained command

Troubleshooting

Resolve common errors