helix shell

​

Usage

helix shell [INSTANCE]

​

Arguments

​

Options

​

Behavior

• Enter one complete v3 query request per line at the helix> prompt. The request’s request_type selects read or write execution.
• Use :quit or :exit (or quit, exit, or end of input) to stop.
• Blank lines are ignored. Invalid JSON and query errors are printed, and the shell keeps running.
• Responses go to stdout exactly as with helix query; the prompt, status footer, and errors go to stderr.
• A typed tenant:<id> / cluster:<id> target works without a helix.toml.
• Local instances use the existing auth-disabled local endpoint.
• Cloud requests use the backend query broker (the Helix Cloud service that forwards CLI queries) and the current WorkOS session; the CLI never contacts the Cloud gateway (the database endpoint that applications use) directly.

​

Examples

# Open a shell against the local 'dev' instance
helix shell dev

# Run newline-delimited requests from a file, one JSON response per line
helix shell dev --json < requests.jsonl

​

Related

• helix query — send one request, including TypeScript DSL input.
• Local workflow — iterate on queries locally.
• Helix Cloud workflow — query a Cloud database.