Rust version 1.88.0 or higher is required. Make sure you have an updated version of Rust installed. Run rustup update to update your Rust version.

​
Installation & Update

CommandDescription
helix installInstall the HelixDB on your machine.
helix updateUpdate the HelixDB to the latest version.
helix versionShow the current version of the CLI and HelixDB.

​
Project Lifecycle

​
helix init [options]

Initialize a new Helix project.
ArgumentsDescription
--path <PATH>The path of the project.

​
helix compile [options]

Lint and compile a Helix project.
ArgumentsDescription
--path <PATH>The path to the project.
--output <OUTPUT>The output path.
--gen <GEN>The target language (possible values: rust, typescript).

​
helix check [options]

Check a Helix project’s schema and queries.
ArgumentsDescription
--path <PATH>The path to the project.

​
Instance Management

​
helix deploy [options]

Deploy a Helix instance.
ArgumentsDescription
--remoteRedeploy a remote instance of HelixDB.
--path <PATH>The path to the project.
--cluster <CLUSTER>Cluster ID if restarting a running instance.
--port <PORT>Port to run the instance on.

​
helix status

Show the status of a Helix instance.

​
helix stop [options] <CLUSTER>

Stop a Helix instance.
ArgumentsDescription
<CLUSTER>Cluster ID to stop.
--allStop all running instances.

​
helix save [options] <CLUSTER>

Save a Helix instance.
ArgumentsDescription
<CLUSTER>Cluster ID to save.
--output <OUTPUT>Where to save the file to.

​
helix delete <CLUSTER>

Delete a Helix instance.
ArgumentsDescription
<CLUSTER>Cluster ID to delete.

​
Authentication

CommandDescription
helix loginLogin to a Helix instance.
helix logoutLogout of a Helix instance.

​
Visualization

CommandDescription
helix visualize <CLUSTER>Open graph visualizer in default browser.