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
| Command | Description |
|---|
helix install | Install the HelixDB on your machine. |
helix update | Update the HelixDB to the latest version. |
helix version | Show the current version of the CLI and HelixDB. |
Project Lifecycle
helix init [options]
Initialize a new Helix project.
| Arguments | Description |
|---|
--path <PATH> | The path of the project. |
helix compile [options]
Lint and compile a Helix project.
| Arguments | Description |
|---|
--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.
| Arguments | Description |
|---|
--path <PATH> | The path to the project. |
Instance Management
helix deploy [options]
Deploy a Helix instance.
| Arguments | Description |
|---|
--remote | Redeploy 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.
| Arguments | Description |
|---|
<CLUSTER> | Cluster ID to stop. |
--all | Stop all running instances. |
helix save [options] <CLUSTER>
Save a Helix instance.
| Arguments | Description |
|---|
<CLUSTER> | Cluster ID to save. |
--output <OUTPUT> | Where to save the file to. |
helix delete <CLUSTER>
Delete a Helix instance.
| Arguments | Description |
|---|
<CLUSTER> | Cluster ID to delete. |
--all | Delete all instances. |
Authentication
| Command | Description |
|---|
helix login | Login to a Helix instance. |
helix logout | Logout of a Helix instance. |
