Guides · Update

Update

Update the harness with rei init --update and the binary with rei update, including the Windows case.

Harness and binary · safe update

When to use it

Use this guide when you want to check whether there is a new version of the binary, update it, or refresh the harness skeleton in a project that already has it initialized.

Requirements

  • To update the binary, a connection to GitHub Releases and write permission on the executable.
  • To update the harness, a project already initialized with .rei/.
  • A backup or a clean commit before forcing changes to the documentation.
  • Knowing the difference between updating the binary and updating the project skeleton.

Steps

  1. Check whether there is a new version with rei update --check. It only reports the result: it does not download or write anything.
  2. Update the binary with rei update. It downloads the asset for your system and architecture, verifies its SHA-256 against checksums.txt and replaces the executable atomically. If the integrity check fails, it aborts without modifying the binary.
  3. On Windows a running .exe cannot be replaced: rei update reports it and opens the releases page so you can download the archive by hand.
  4. Update the harness skeleton with rei init --update. It requires an REI project; it does not install from scratch and never touches .rei/specs/** or .rei/progress/**.
  5. Review the warnings. --update is marker-aware: it updates the customization documents that still contain the pending marker and keeps those already customized. The rest of the files are updated only if the manifest confirms they were not modified.
  6. Use rei init --update --force only if you accept overwriting any file that differs, including customized or hand-edited ones. The result is reported as [NEW], [UPD], [OK] or [SKIP].
Binary
rei update --check
rei update
Harness
rei init --update
rei init --update --force
rei init status

Verification

Shell
rei version
rei init status
rei check
rei validate

rei version confirms the binary version. rei init status tells you whether any documentation is still pending customization. rei check verifies the harness and the project checks, and rei validate reviews the consistency of a Work Item.

If the binary update fails because of the network, permissions or checksum, the previous executable is left intact. If the replacement fails after it has started, the original is restored.

Limits

  • rei init --update does not install the harness from scratch: use rei init for that.
  • --update does not modify .rei/specs/** or .rei/progress/**: work in progress is not lost.
  • Customized documents are kept with a warning; only --force overwrites them.
  • --update regenerates native subagents only if the project already has .opencode/ or .claude/.
  • On Windows, the binary update is manual from the releases page.

Next step

After updating, run the checks again and, if the harness changed, review the command reference and the installation.

Planning approval

Pending

A human sign-off releases the sheet. Silence is not approval.

Approval is recorded from the CLI; the viewer does not replace it.