​

Installing HelixDB

HelixDB can be used locally by installing the HelixCLI.

​

HelixCLI installation

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

​

Verifying Installation

To verify that HelixCLI is installed correctly:

helix --version

​

Install Helix

helix install

​

Setup

helix init --path <path-to-create-files-at>

​

Write queries

Write your schema and queries in the newly created .hx files. Click here for more information about writing queries

​

Check your queries (optional)

cd <path-to-your-project>
helix check

​

Deploy your queries

cd <path-to-your-project>
helix deploy

​

Other 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.