Install PlanQ

PlanQ provides one official package channel for each supported target. The current stable release is sourced from the same signed-off release set across all three channels.

Support matrix

Operating system	Target	Official channel	Package
macOS	Apple Silicon (arm64)	Homebrew	planq-cli/tap/planq
Windows	x86_64	winget community source	PlanQ.PlanQ
Linux	glibc x86_64	npm	@planq-cli/planq

macOS x86_64, Linux arm64, Linux musl/Alpine, and Windows arm64 are currently unsupported. Do not install a package built for a different platform.

macOS Apple Silicon

Install:

brew install planq-cli/tap/planq
planq version

Upgrade or uninstall:

brew upgrade planq
brew uninstall planq

Windows x86_64

Install from the winget community source:

winget install --id PlanQ.PlanQ --exact
planq version

Upgrade or uninstall:

winget upgrade --id PlanQ.PlanQ --exact
winget uninstall --id PlanQ.PlanQ --exact

Linux glibc x86_64

The npm wrapper requires Node.js 20 or newer. Node.js is an installation prerequisite for this channel only; the PlanQ executable itself is native.

Install globally:

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

Run without a global install:

npx @planq-cli/planq version

Upgrade or uninstall:

npm update --global @planq-cli/planq
npm uninstall --global @planq-cli/planq

The wrapper installs the exact matching @planq-cli/linux-x64 optional dependency. Do not use --no-optional.

CLI and project Skill lifecycle

Package managers install or remove the planq executable. They do not modify your repositories, .plan files, home directory, editor configuration, or shell profile.

The optional plan-gantt Agent Skill is project-scoped. Its complete canonical payload lives at .agents/skills/plan-gantt/; planq skill install also creates lightweight project discovery forwarders for Claude Code and TRAE. Upgrading or uninstalling the global CLI does not delete these repository files. See Agent Skill.

If you are using a coding agent, the workbench's handoff prompt will ask the agent to verify its environment by running planq version and planq skill status before changing a plan.

Depending on the output of planq skill status, your agent will handle the following states:

• Missing: The agent runs planq skill install once and checks both the canonical status and its matching result.integrations entry again.
• Conflict: The agent pauses and reports the relative conflict paths.
• Current: The agent still explicitly reads .agents/skills/plan-gantt/SKILL.md before changing a plan.

The Skill command has no global mode: do not create .codex/skills, a user-Home Skill, or use --global, --agent, or --force.

For more details on how agents interact with the CLI and project skills, see Agent Skill.

License and release integrity

PlanQ is distributed under PolyForm-Noncommercial-1.0.0. Each GitHub Release contains SHA256SUMS and planq-release-v1.json beside immutable platform archives. Package channels are the supported install path; source builds and direct archive downloads are not substitutes for package-channel acceptance.

Continue with the Quickstart. For platform or installation errors, use Troubleshooting.