Skip to content

Compatibility

AreaCurrent target
TypeScript/Node packagesNode >=22 where package engines are declared.
Python packagesPython >=3.12.
Go modulesGo 1.26 where modules declare a version.
Root package managerpnpm@11.1.1.
TargetSource
Local developmentcaracal up and infra/docker/docker-compose.yml.
Self-hosted Composeinfra/docker/runtime-compose.yml with versioned GHCR images.
Kubernetesinfra/helm/caracal.
Docs siteAstro ^7.0.6 and Starlight 0.41.3.
  • Release binaries target Linux x64/arm64, macOS x64/arm64, and Windows x64.
  • Current Kubernetes operations guidance targets Kubernetes 1.30 or newer.
  • Published modes are rc and stable. They use the same fail-closed security posture; rc denotes pre-release maturity, not relaxed security.

Caracal packages release in lockstep: every @caracalai/* npm package, caracalai* Python distribution, and Go module tag carries the same version, and cross-package wire contracts are only validated within one release. Pin every Caracal package in a service to one exact version and upgrade them together - a mixed set (for example an older @caracalai/oauth under a newer @caracalai/sdk) is unsupported and can fail in ways that look like platform errors. Lockfiles make this the default; when bumping, change every Caracal entry in the same commit.

Caracal is on a pre-1.0 SemVer line. Patch releases preserve documented public behavior while repairing defects. A minor release may change public APIs or operational contracts, so read its release notes and upgrade all Caracal artifacts together.

Compatibility promises cover documented package exports, public product APIs, and raw protocol fields identified as wire contracts. Internal storage names, internal endpoints, unpublished exports, and implementation details are not public compatibility guarantees. When a public surface is deprecated, its notice names the replacement and intended removal minor; pre-1.0 consumers must not assume a multi-major deprecation window.

This open-source compatibility policy does not imply a support SLA.

Use Release Map to map product versions to packages, images, and release surfaces.