Skip to content

PlanQ documentation ​

PlanQ is a Git-native planning CLI and DSL for authoring, validating, and previewing project plans as read-only Gantt charts.

Install ​

The shared npm command supports all three targets in the 0.1.8 release:

bash
npm install --global @planq-cli/planq

Current npm latest (0.1.8) is available on macOS arm64, Linux glibc x86_64, and Windows x86_64. The Windows winget channel remains pending.

Review prerequisites, upgrades, and supported targets →

Create your first plan ​

  1. Confirm the installed version with planq version.
  2. Create a plan with planq init project.plan --id demo --name "Demo".
  3. Validate it with planq validate project.plan.
  4. Open the read-only preview with planq dev project.plan.

Follow the five-minute Quickstart →

Continue from here ​

PlanQ preserves author intent in .plan files. Validation and normalization produce read-only results; only an explicit planq format command writes canonical source back to disk.

PlanQ documentation