Quickstart

This path starts in an empty directory and uses only an installed planq executable. No account, source checkout, JVM, Workspace, GitHub repository, resource catalog, or editor extension is required.

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.

1. Confirm the installation

planq version

If 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.plan

If 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.plan

This starts a local server and opens a read-only Gantt chart in your browser. Your plan data stays on your machine and is never uploaded.

For a remote terminal or automation environment:

planq dev project.plan --no-open

Open 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.

If validation or preview fails, follow the stable diagnostics in the command output and open Troubleshooting.