Tutorial
The helix CLI scaffolds projects, runs local HelixDB instances, sends queries, and
manages Helix Cloud resources. Local commands need only Docker or Podman; Cloud
commands also need a Helix Cloud account.
Install
macOS and Linux:helix. Check with helix --version; update
later with helix update.
Install locations and options (macOS and Linux)
Install locations and options (macOS and Linux)
The script installs It always installs the latest release.
~/.local/bin/helix and, for bash, zsh, or fish, appends a PATH line to
~/.bashrc, ~/.zshrc, or ~/.config/fish/config.fish if that file exists and lacks it. Restart
the shell afterwards. Pass options after bash -s --:Install locations and options (Windows)
Install locations and options (Windows)
The script installs
%LOCALAPPDATA%\Helix\bin\helix.exe on x86-64 Windows and adds it to your user
PATH; open a new PowerShell afterwards. To pass options, run it as a script block:Pin a version in CI
Pin a version in CI
Release tags are See Scripting and CI for JSON output and exit codes.
v<version>, with one binary per platform: helix-x86_64-unknown-linux-gnu,
helix-aarch64-unknown-linux-gnu, helix-x86_64-apple-darwin, helix-aarch64-apple-darwin, and
helix-x86_64-pc-windows-msvc.exe. On macOS and Linux, download the binary; on Windows, use
-Version.Local quickstart
--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 init cloud picks your workspace, project, and database (the only one of each, or asks) and
links them in helix.toml as the production instance. It writes no example request: -e builds
one from TypeScript and needs Node.js 20+ and npm, or pass a JSON
request file with --file. Later Cloud commands in
the directory, such as helix database or helix logs production, need no IDs or flags.
Cloud commands use only your rotating WorkOS session; there is no gateway URL, application key,
service credential, or sync step. Queries go through the backend broker and need
database.query.read or database.query.write on the database’s project.
When a command cannot choose a resource, pass it by ID, slug, or name, for example
helix database list --project <project> or helix query tenant:<id> --file request.json. Links
live only in the project’s helix.toml. See
Cloud resource resolution.
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