Skip to content

Versions & releases

How the API, CLI, SDK and MCP server are versioned, how the numbers relate, and what a version change means for you.

Each hlix surface carries its own version number, and the numbers move independently. A CLI release does not change the API, and an API change does not force a package release.

For the current version of each package, see Current versions. This page explains what those numbers mean.

Surface Scheme Example Meaning
CLI semantic versioning 1.2.3 the hlix command and its JSON output
TypeScript SDK semantic versioning 1.2.3 the @hlix/sdk library
Python SDK semantic versioning 0.1.0 the hlix-sdk package, imported as hlix
Go SDK semantic versioning v0.1.0 the github.com/hlix-ai/hlix-go module
MCP server semantic versioning 1.2.3 the hosted server at https://mcp.hlix.ai/mcp
API contract semantic versioning 1.0.0 the published request and response shapes
API URL major prefix /v1/api the boundary between breaking API generations

Platform updates ship continuously and do not change these numbers unless a published surface changes.

Hlix is in early access. Existing published versions continue forward; they are not reset or republished. New, unpublished components start at 0.1.0.

  • patch — compatible fixes, polish, and additions.
  • minor — an intentional new minor line. For pre-1.0 components, use it for deliberate breaking changes.
  • major — a new compatibility boundary for breaking changes.

Historical package versions, release tags, and native build numbers are preserved. API URL generations and third-party dependency versions are separate from product release numbers.

For the API contract:

  • major — an older client can break; it comes with a new URL prefix;
  • minor — additive routes or fields;
  • patch — documentation-only corrections to the contract.

A package version bump does not change the API version, and the URL prefix stays /v1/api until a major API version.

Homebrew and the one-line installer distribute the same CLI release as npm, as one self-contained executable per platform. The installer verifies a checksum before it installs anything. See Install the CLI.

Terminal window
hlix --version
npm view @hlix/cli version
npm view @hlix/sdk version

Current versions states the version each channel serves, and the Changelog lists what changed in each.

  • hlix --version differs from npm view @hlix/cli version — which -a hlix shows which installation runs. Check for an older copy or an intentional version pin.
  • A Homebrew install is behind npm — run brew update && brew upgrade hlix.
  • A platform update changed nothing in a package — expected. The numbers move independently.