Apps

Reports — Plans

Create a plan locally, record decisions explicitly, and publish immutable versions in Reports.

Keep a plan current

Use the openape.plan/1 JSON template installed with @openape/ape-testruns. It separates decisions, milestones, acceptance criteria, risks and evidence.

ape-report-render plan plan.json plan.html
ape-reports preview plan.html --check
ape-reports teams
ape-reports publish plan.html --category Plans --team TEAM_ID --key PLAN_KEY

Team access is explicit; omit --team to keep the plan owner-only. Manage teams and invitations with ape-reports teams --help. No invitation is sent automatically.

Before editing, read the current document and version using ape-reports show ID. Reconcile other authors' changes, render the updated JSON, then publish with --document ID --expected-version VERSION --key NEXT_KEY. Keep the same key and bytes when recovering an uncertain request.

Record actual owner approval and the exact approved version separately. A status such as active or done is not approval. Existing Plans links remain readable for authorized readers; the old CLI remains available during migration.