Helix Framework Documentation

Environment

Installation

Prepare the local toolchain required to evaluate or adopt Helix Framework in a Java and Spring Boot environment.

Requirements

Helix targets modern Java service development and assumes a baseline toolchain that most Spring Boot teams already use.

  • JDK 17 or newer
  • Gradle-compatible build environment
  • Access to the Helix CLI
  • A local shell environment for running project generation and verification commands

Install the CLI

The Helix CLI is the entry point for generating projects and working with the framework templates locally. Homebrew is the recommended installation path when it is available in your environment.

Install with Homebrew

Install the CLI with Homebrew

brew tap helixframework/helix
brew install helix-cli

Install with curl

Install the CLI with the install script

curl -fsSL https://raw.githubusercontent.com/helixframework/helix/main/helix-cli/install.sh | bash

After installation, verify that the binary is available from your shell.

Verification

Check CLI availability

helix --help

Verify the toolchain

Once Java, Gradle, and the CLI are available, run a local project build to confirm the environment is ready for framework evaluation.

Verification

Build a generated project

./gradlew bootRun

Successful execution confirms the environment can create, configure, and build a Helix-based application using the standard workflow.