Reference
Every helix command, grouped the same way as helix --help. Scope shows whether a command
works with local instances, Helix Cloud, or both.
Cloud commands authenticate only with the WorkOS session created by helix auth login.
They never accept or store application database keys or service credentials.
Getting started
Instances and queries
Helix Cloud
CLI utilities
Global options
These flags work with every command, except-V, which works only as helix --version.
Output
- stdout carries only the command’s result: tables, detail views, query results, one-time tokens, or the
--jsonpayload. It is always safe to pipe. - stderr carries everything else: progress sessions, spinners, warnings, hints, and errors.
- Destructive Cloud commands (
project delete,database delete,database key revoke,service-credential revoke) ask for confirmation in a terminal. Without one, or with--json, they fail before any request unless you pass-y/--yes. They never act on an “only candidate” they were not told about: the target must be named, linked inhelix.toml, or picked in a terminal.
--json payload,
and the commands that refuse --json.
Targets and resolution
Instance names come fromhelix.toml. Helix Cloud workspaces, projects, clusters, and databases
have their own IDs, slugs, and names, resolved through the Helix Cloud API. The namespaces are
separate: helix query production looks for an instance named production, while
helix database get orders looks for a Cloud database named orders.
logs, status, cypher, and explorer reject typed tenant:<id> / cluster:<id> targets; link
the database with helix add cloud first. Without a terminal, a command that cannot pick a default
fails with no default query target or no default local instance and lists the instances.
Cloud resource resolution
Workspace, project, cluster, and database arguments are optional and accept an ID, slug, or display name, matched in that order (names are case-insensitive). Databases also accepttenant:<id> and
cluster:<id>. Application keys and service credentials are passed by ID or name. Exception:
helix service-credential --grant takes a project ID only; find it with helix project get <project>.
An omitted resource resolves to:
- the project or databases linked in
helix.toml; - the only candidate, announced on stderr (for example
Using project <name>); - an interactive picker, in a terminal and without
--json; - otherwise, an error that lists the candidates and how to pass one.
tenant:<id> / cluster:<id> must belong to any --project / --workspace you also pass, so
helix database delete tenant:<id> --project <other> fails instead of acting outside that project.
There is no global or persisted workspace or project selection. A group run without a subcommand
lists its resources with the defaults above: helix project is helix project list. Flags such as
--project go after the subcommand: helix database list --project <project>, not
helix database --project <project>, which fails as an unexpected argument.
Removed and unsupported commands
push, sync, config, auth create-key, workspace switch, and project update are not commands.
compile, check, and deploy were removed; running them prints a pointer to the current workflow.
--format and --compact were replaced by --json; the inline request body of helix query and
helix api is now --body. --workspace-id, --project-id, and --cluster-id were replaced by
the resolution above, and helix logs --range by plain --start/--end. Cloud resource lifecycle
is exposed only where documented above.