Docs · Get started

Update KyoubeAI

Move a KyoubeAI install to a new release with update.sh, which backs up first, and go back to the previous release with one command if needed.

KyoubeAI 1.11.0 · · Source on GitHub (opens in a new tab)

./update.sh

It downloads the newest release's image before it changes anything, then:

  1. backs up (scripts/backup.sh);
  2. switches the checkout to the new release;
  3. adds any new settings to .env and moves KYOUBE_VERSION and KYOUBE_CORE_VERSION to the new release; your other settings are never changed;
  4. restarts;
  5. offers to install any harness your agents use that is not installed;
  6. runs kyoube doctor.

--version <x.y.z> picks a release (not one older than the release you are on), and --yes answers every question. An update that stops part way continues when you run ./update.sh again, without a second backup. Harnesses, their logins and kept system packages carry over (Harnesses).

If an update goes wrong, ./update.sh --rollback goes back to the previous release and restores the backup taken just before the update. Anything written since then is replaced, because databases only migrate forward; the .env it replaces is kept as .kyoube/env.before-rollback. A rollback that stops part way is finished by running ./update.sh --rollback again.

An install built from source (./install.sh --edge) updates with ./update.sh --edge, which fast-forwards the current branch and rebuilds. docs/upgrading.md covers moving to 1.1 from an earlier install, and moving KyoubeAI to a new core release.