​
Workflow

1

Install HelixCLI

Install the HelixCLI using the following command

curl -sSL https://install.helix-db.com | bash

​
Add Helix to your PATH

echo 'export PATH="$HOME/.local/bin:$PATH"' >> "$HOME/.zshrc"
source ~/.zshrc

​
Verify Installation

To verify that HelixCLI is installed correctly

helix --version
2

Install Helix

Install the Helix container using the following command

helix install
3

Setup

Setup a new project using the following command

helix init --path helixdb-cfg
4

Write Schema and Queries

Write your schema and queries in the newly created .hx files.

Click here for more information about schema and queries.

5

Check Queries (optional)

Check your queries using the following command

helix check
6

Deploy Instance

Deploy your instance using the following command

helix deploy

​
Other Useful Commands

  • helix instances to see your local instances.
  • helix stop <instance-id> to stop your local instances.
  • helix stop --all to stop all your local instances.
  • helix start <instance-id> to start your local instances.
  • helix rebuild <instance-id> to rebuild an instance without deploying a new instance (keeps the data).
  • helix label <instance-id> <label string> to label your local instances.