Skip to main content
For the complete documentation index optimized for AI agents, see llms.txt.
Deploy a Helix Cloud instance. helix push reads the [enterprise.<instance>] block in helix.toml and deploys it to Helix Cloud, then reports progress until the deploy completes. Requires Helix Cloud authentication. Run helix auth login first.
helix push only deploys Helix Cloud ([enterprise.*]) instances. To run a local instance, use helix start instead. helix deploy is a removed v1 command — helix push replaces it.

​
Usage

helix push [INSTANCE]

​
Arguments

ArgumentDescription
INSTANCEHelix Cloud instance name from helix.toml. If omitted, the CLI prompts in a TTY, or fails listing the available [enterprise.*] instances when non-interactive.

​
Behavior

  • Resolves the named [enterprise.<instance>] block and deploys it to Helix Cloud, streaming deploy progress.
  • Fails on a local instance with Local instance '<name>' uses the v2 runtime. Run 'helix start <name>' instead.
  • On deploy failure, the CLI hints to check the cluster with 'helix status', and re-authenticate with 'helix auth login' if needed.

​
Examples

# Deploy a named Helix Cloud instance
helix push production

# Deploy without naming the instance (prompts in a TTY)
helix push
  • helix auth — authenticate with Helix Cloud before deploying
  • helix sync — refresh gateway/auth metadata after a deploy
  • helix query — query the deployed instance
  • helix status — check the deployed cluster’s state