Installation & Setup

CommandDescription
helix installInstall the HelixDB runtime on your machine.
helix updateUpdate HelixDB to the latest version.
helix initInitialize a new HelixDB project in the current directory.
helix versionShow the current version of the CLI and HelixDB.

Development Commands

CommandDescription
helix compileCompile your HelixDB project.
helix checkValidate your project’s correctness before deployment.

Deployment & Instance Management

CommandDescription
helix deployDeploy the compiled project as a new instance.
helix instancesList all your local HelixDB instances.
helix start <instance-id>Start a specific local instance.
helix stop <instance-id>Stop a running local instance.
helix redeploy <instance-id>Redeploy an instance while preserving data.
helix label <instance-id> <label>Assign a custom label to your instance.
helix save <instance-id>Save the current data.mdb file of an instance.
helix visualize <instance-id>Visualize an instances internal graph.

Cloud Authentication

CommandDescription
helix loginLog in using GitHub or check current credentials.
helix logoutLog out and clear your saved credentials.