Quickstart
You can start from the public project template or create one plan in an empty directory. Both paths use only an installed planq executable. No account, source checkout, JVM, Workspace, or editor extension is required.
For npm, install Node.js 20 or newer and follow the current platform status on the installation page. The native planq executable itself does not require Node.js, a JVM, or Clojure.
If you arrived from the example workbench, Use in my project provides the Hand off to your coding agent workflow. Follow the coding-agent handoff guide for the copyable prompt, CLI and project Skill checks, validated writes, and optional preview. This page remains the manual CLI path.
Start from the project template
The PlanQ starter repository is a GitHub template with a small editable plan and two complete examples:
git clone https://github.com/planq-cli/plan-starter.git
cd plan-starter
planq project validate
planq devTo use a coding agent in the cloned repository, install the project-scoped Skill and check its result:
planq skill install
planq skill statusCreate a minimal plan
1. Confirm the installation
planq versionIf everything is set up correctly, this will return a JSON object with your current version. If the command isn't found, head over to the installation guide to get set up.
2. Create a plan
mkdir planq-quickstart
cd planq-quickstart
planq init project.plan --id demo --name "Demo"This creates a new project.plan file in your directory. (Don't worry, it won't overwrite an existing file if one is already there.)
3. Validate it
planq validate project.planIf your plan is well-formed, you'll see a success message. You might get some warnings, but as long as there are no errors, your plan is valid.
4. Open the Gantt preview
planq dev project.planThis serves the workbench bundled with your CLI and opens a read-only Gantt chart. It does not probe the hosted site or require a product account. Preview does not upload your source or local results. If PLAN_SITE is set, add --local to force the bundled view; see Local Preview.
For a remote terminal or automation environment:
planq dev project.plan --no-openOpen the printed URL manually. Press Ctrl+C in the terminal to stop the preview and remove its local session discovery file.
Next steps
- Add tasks, milestones, dates, and dependencies in Authoring Plans.
- Hand off to your coding agent through the project-scoped Agent Skill.
- Configure a multi-entry repository with Project Structure.
- Connect an editor through Editor Integration.
- Use Manage in PlanQ to open the site without uploading this preview. Commit and push your project first, then explicitly bind it through GitHub Sync. Your local files are already saved; the site stores synchronized results and workspace management state.
If validation or preview fails, follow the stable diagnostics in the command output and open Troubleshooting.