Quickstart

First useful continuation pack in five minutes.

Install from PyPI, create local project memory, inspect the files, and run checkpoint continue.

Prerequisites

  • Python 3.9+ installed.
  • A terminal open in your project directory.

Minute-by-minute path

  1. Install the CLI.

    # pip
pip install checkpoint-cli

# uv
uv add checkpoint-cli

  2. Set up user context.

    checkpoint setup-user

  3. Initialize project memory.

    checkpoint init
checkpoint status

  4. Generate a continuation pack.

    checkpoint continue

What success looks like

After checkpoint init, you should see a .contextos/ directory in the project. checkpoint continue should print a Markdown continuation pack or a minimal pack that explains what context is currently available. 

.contextos/
  context/
  tasks/
  handoffs/
  state/

If the project is still empty

Not broken, just early.

A fresh project may not have a meaningful handoff or active task yet. Run checkpoint status, inspect .contextos/, then add real project notes before expecting a rich continuation pack.

Next

See the demo or inspect the file layout