Install the CLI

Install the hlix CLI, verify the installation, and resolve common setup errors.

Use the hlix CLI to import local projects, sync files, and manage work from your terminal.

Install

curl -fsSL https://hlix.ai/install.sh | bash
hlix --version

One self-contained executable, installed into ~/.local/binafter its checksum is verified. Run it again to upgrade. SetHLIX_INSTALL_DIR to install somewhere else.

brew install hlix-ai/tap/hlix
hlix --version

npm install --global @hlix/cli
hlix --version

pnpm add --global @hlix/cli
hlix --version

yarn dlx @hlix/cli@latest --help

Runs the latest CLI without a global installation. Use Yarn 2 or later.

bun add --global @hlix/cli
hlix --version

vp install -g @hlix/cli@latest
hlix --version

Requires the Vite+ global CLI.

npx @hlix/cli --help

Yarn and “Run once” launch a command without installing hlix globally. In later examples, replace hlix with the launcher you chose, such as yarn dlx @hlix/cli@latest.

In CI, and anywhere the toolchain must not change underneath you, pin the version instead of floating to latest:

curl -fsSL https://hlix.ai/install.sh | HLIX_VERSION=2.0.0 bash
npm install --global @hlix/cli@2.0.0

Prerequisites

macOS or Linux for the installer and Homebrew; Windows can use npm
Node.js 22.19 or later for Node-based launchers or the Node.js fallback; the installer and Homebrew provide a self-contained executable
Git
A hlix account for browser sign-in, or an API key and workspace ID for CI from Developer tools → API keys

Verify the install

hlix --version
hlix --help

Expected result: the first prints a semantic version, the second prints the registered command table.

If installation fails

hlix: command not found after the installer: ~/.local/bin is not on your PATH yet. The installer prints the exact line to add to your shell profile; add it, then open a new shell.
checksum mismatch … Nothing was installed: the download did not match the published release, often because a proxy rewrote it. Your existing hlix, if any, is untouched. Run the installer again, or use npm.
musl-based Linux (such as Alpine) is not supported by this installer: install with npm instead.
The installer address does not answer: the same script is published with every release at https://raw.githubusercontent.com/hlix-ai/homebrew-tap/main/install.sh. Pipe that one into bash instead.
hlix: command not found after an npm install: your global npm bin directory is not on PATH. Run npm prefix -g, add its bin subdirectory to your shell profile, then open a new shell.
EACCES: permission denied during a global install: npm is trying to write to a root-owned prefix. Set a user-writable prefix (npm config set prefix ~/.npm-global) rather than installing with sudo.
SyntaxError or an engine warning on startup: confirm node --version is 22.19 or later.
npm error E404: check that the package name is @hlix/cli and that your npm registry is configured correctly.
hlix --version prints an older number than you installed: an earlier binary is still first on PATH. which -a hlix shows which one wins.

One copy per machine

Choose one installation method. The installer detects an existing Homebrew or npm copy and shows its upgrade command. To switch methods, pass --replace; it first uninstalls the existing copy through Homebrew or npm.

curl -fsSL https://hlix.ai/install.sh | bash -s -- --replace

If multiple copies are installed, hlix status lists them on its duplicate line and shows how to remove the extra.

Uninstall

Installed with the one-line installer: hlix uninstall. Your login in ~/.config/hlix is kept.
Installed with Homebrew: brew uninstall hlix.
Installed with npm: npm uninstall -g @hlix/cli.