Planr Documentation

Planr is a local-first planning and execution coordination tool for Codex, Claude Code, Cursor, and generic MCP or CLI clients. It keeps product intent readable, graph state authoritative, ownership explicit, and completion backed by evidence.

Set up with your agent

Give Codex, Claude Code, or Cursor one safe setup prompt, then start with $planr.

Install and start

Install Planr, verify the binary, and reach your first ready item.

Understand the model

Learn how plans, maps, picks, logs, reviews, and recovery fit together.

Connect a client

Set up Codex, Claude Code, Cursor, generic MCP, or CLI-only use.

Optional plugins

Use external integrations without moving Planr Core ownership.

Look up a surface

Find canonical CLI, MCP, HTTP, configuration, and data contracts.

The lifecycle

Planr uses one public flow across clients:

idea -> product plan -> build plan -> map -> pick -> log -> review/evidence -> recovery/package -> close

The map is the live source of truth. Plans preserve intent and verification context; logs and reviews prove why a state transition is safe.

Local by default

Planr stores project coordination state beside your repository. It does not require a hosted account, analytics service, or cloud content backend.

Choose your next step

New user: install Planr, then follow the quickstart.
Agent-led setup: choose the Agent Quickstart, then use $planr for the first request.
Existing project: open the guides for scoped planning, coordination, and recovery.
Integrator: choose a supported path under client integrations.
Plugin operator: start with optional plugins and verify external lifecycle boundaries.
Contributor: start with repository and documentation contribution.