helix

The official CLI for Cirrus Host — deploy Workers and Containers in seconds, with built-in databases, storage, and KV.

Install

npm install -g @cirrustech/helix

Requires Node.js 18+.

Quick start

Worker:

helix login
helix init my-project
cd main && helix deploy

Container (existing public image — Plex, Postgres, n8n, nginx, …):

helix init --container plex \
  --image lscr.io/linuxserver/plex:latest \
  --port 32400
cd main && helix deploy

Your container is live at https://main.plex.helx.dev.

Container (your own Dockerfile):

helix init --container my-project
cd main
# build & push your image, then set "image" in helix.json
helix deploy

Commands

| Command | Description | |---|---| | helix login | Device-code login (opens browser) | | helix logout | Forget local credentials | | helix whoami | Show signed-in user | | helix init [name] | Scaffold a new app (-c for container) | | helix deploy [-m msg] | Build and ship to the platform | | helix list [project] | List projects or deployments | | helix logs | Stream live logs | | helix open | Open the deployment URL in your browser | | helix delete [name] | Delete a deployment | | helix env list\|set\|unset | Manage environment variables | | helix secrets list\|set\|rm | Manage encrypted secrets | | helix domain list\|add\|verify\|rm | Manage custom domains | | helix project list\|create | Manage projects | | helix members list\|invite\|remove | Manage project collaborators | | helix invites list\|accept\|decline | View and respond to invites | | helix notifications list\|read | In-app notifications | | helix db create\|list\|rm\|execute | Dedicated databases (SQLite) | | helix bucket create\|list\|rm | Object-storage buckets | | helix kv create\|list\|rm | Key-value stores | | helix bindings list\|add\|rm | Attach resources to a deployment | | helix usage | Show period usage |

Scope flags

Every command accepts these flags to target a specific project or deployment without needing to be inside the project directory:

-p, --project <slug>     Target project
-n, --name <name>        Target deployment
--panel <host>           Use a different panel domain (white-label)

When omitted, helix reads from helix.json in the current directory.

helix logs -p my-project -n api
helix env set DEBUG=1 -p my-project -n api

Documentation

cirrus-host.com/docs

License

MIT