​
Workflow

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.
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
or install the development version with
helix install --dev
3

Setup

Setup a new project using the following command
helix init --path helixdb-cfg
cd 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