PlanQ documentation

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

Install

Choose the one supported channel for your platform:

Platform	Install
macOS Apple Silicon	brew install planq-cli/tap/planq
Windows x86_64	winget install --id PlanQ.PlanQ --exact
Linux glibc x86_64	npm install --global @planq-cli/planq

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

Hand off to your coding agentFrom a workbench prompt to a Skill-guided, validated plan change.Editor integrationConnect Emacs, VS Code, or Neovim to the PlanQ language server.GitHub syncPublish validated repository plans to a read-only Workspace.

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.