docs blog library
github

Upgrading Jazz

Run jazz update to install the latest release. Before a minor-version update, read the release notes for migration steps. If you need to keep the current version, skip jazz update or install a specific version as shown in Updating.

Versioning policy

Jazz is pre-1.0. Its version is 0.MINOR.PATCH:

ReleaseWhat it may containYour action
Patch (0.15.44 to 0.15.45)Fixes and additions. No renamed or removed config keys, flags or output fields.No migration expected. Validate your configuration after updating.
Minor (0.15.x to 0.16.0)Anything a patch may, plus breaking changes, each listed with its migration.Read the release’s Breaking section before updating.
Major (1.0.0)The first release with a stable contract; after it, breaking changes wait for 2.0.

“Breaking” means a change that makes a working setup fail or behave less permissively: a renamed or removed config key, flag or envelope field, or a default that now grants less. A default that grants more is never shipped silently in any release.

Read the GitHub release notes before updating. Breaking changes should include the migration steps needed to keep your setup working.

Updating

jazz update

jazz update replaces a binary install from the GitHub release, or goes back through npm, bun, pnpm or yarn for a package install. Chat bots deployed from a checkout follow release tags on their own; see Keeping it updated.

To stay on a version, install it explicitly and skip jazz update:

curl -fsSL https://github.com/lvndry/jazz/releases/latest/download/install.sh |
  JAZZ_VERSION=v0.15.44 bash

When an update rejects your config

~/.jazz/config.json is validated strictly: a key Jazz does not know is reported as an invalid configuration. To find and fix rejected keys:

jazz config validate

It names each rejected key, and suggests the closest known one (autoApproveCommands: not a setting, did you mean autoApprovedCommands?). Look it up in the GitHub release notes, rename or remove it, and run jazz config validate again until it exits 0.

Going back

If a release breaks something the release notes did not warn about, reinstall the previous version with JAZZ_VERSION as shown above and open an issue with the error.

machine-readable: /docs/upgrading.md · /llms.txt · /llms-full.txt