PlanQ starter

This repository is a ready-to-use PlanQ project template. It includes a small starter plan and two larger examples that share one project resource catalog.

Get started

Install the supported planq CLI for your platform by following the installation guide.

Create a repository from this template in GitHub, or clone it directly:

git clone https://github.com/planq-cli/plan-starter.git
cd plan-starter
planq project validate
planq dev

planq dev opens the starter plan first and also makes crm-demo.plan and infra-migration.plan available in the entry switcher. To preview only one of the full examples, run:

planq dev crm-demo.plan
planq dev infra-migration.plan

The preview is read-only. Edit starter.plan, the example plans, and resources.plan in your repository, then run planq project validate again. No Node.js, Vite, or source checkout is required.

infra-migration.plan includes unscheduled work, so planq project validate reports dep/order-unresolved warnings for it. The command still succeeds: constraints can exist before dates do.

Use a coding agent

The template does not include a pinned copy of the PlanQ Agent Skill. Install the Skill into your project with the CLI that your agent will use:

planq skill status
planq skill install
planq skill status

Read result.status from planq skill status:

• missing: install the Skill and check the status again.
• current: read .agents/skills/plan-gantt/SKILL.md before editing plans.
• conflict: stop and review the reported project files; do not overwrite them automatically.

See the coding-agent handoff guide for the complete workflow.

Project files

• starter.plan: a small plan intended for editing.
• crm-demo.plan: a complete multi-phase delivery example derived from PlanQ's canonical demo.
• infra-migration.plan: a cross-team infrastructure migration example derived from PlanQ's canonical example.
• resources.plan: the shared mock people catalog for every entry.
• plan.manifest.json: the ordered project entry list.

License

The files in this template repository are licensed under the MIT License. The PlanQ CLI and product source are separate works distributed under PolyForm-Noncommercial-1.0.0.