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/planqCurrent 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
- Confirm the installed version with
planq version. - Create a plan with
planq init project.plan --id demo --name "Demo". - Validate it with
planq validate project.plan. - 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.