Skip to content

Quickstart

1. Install

macOS:

brew install chuxorg/yanzi/yanzi

macOS or Linux install script:

curl -sSL https://raw.githubusercontent.com/chuxorg/yanzi/main/install.sh | bash

Windows:

  • download yanzi-windows-amd64.zip
  • extract yanzi.exe
  • add the extract directory to PATH

2. Create a Project

yanzi project create demo
yanzi project use demo

3. Capture Work

yanzi capture \
  --author "Ada" \
  --prompt "Summarize the current task" \
  --response "Set up the project and record the first state."

4. Create a Checkpoint

yanzi checkpoint create --summary "Initial project state"

5. Rehydrate

yanzi rehydrate --dry-run
yanzi rehydrate

Optional: Message Channel

yanzi message send --to claude --from ada --channel handoff --content "Start from the latest checkpoint."
yanzi message pull --to claude --channel handoff