Local preview
PlanQ includes a production workbench inside the CLI. By default, dev and show serve its HTML, JavaScript, CSS, and language resources from your machine. You do not need a product account, a reachable PlanQ site, or frontend dependencies in your project. The workbench and CLI are released together with matching protocols.
Persistent preview
planq dev project.plandev watches the entry, its includes, and shared resource files. Saves refresh the same browser view. Invalid saves display diagnostics while preserving the last valid Gantt result. Without explicit entries, dev reads the project's plan.manifest.json.
Eligible unscheduled tasks are solved automatically. During a re-solve the workbench keeps the previous complete view; see Automatic Scheduling.
planq dev project.plan --port 4173 --no-openPress Ctrl+C to stop the preview and remove its temporary session discovery file.
Choose local or site preview
Use --local to force the bundled workbench even if your environment selects a site:
planq dev project.plan --localPLAN_SITE="" also selects local preview. --local conflicts with --site and --force-site.
To explicitly use a hosted workbench:
planq dev project.plan --site https://planq.dev--site takes priority over PLAN_SITE. A non-empty PLAN_SITE selects that HTTPS site; https://plan.tidean.com is the supported China endpoint. Invalid site values are rejected unless overridden by --local.
Site preview first probes /protocol.json. An incompatible protocol, timeout, or unknown response switches to the bundled workbench. Product release numbers need not be identical; the live protocol is the relevant compatibility check. To skip the check deliberately, use --force-site. Without another site setting, it selects https://planq.dev. It can fail in the browser if the protocol is unsupported.
Missing or mismatched bundled resources are an installation/build error, not a recoverable network issue. Reinstall PlanQ rather than forcing a broken local bundle to load. Offline preview assumes your plan, required local resources or accepted lock, and solver are available. Installation through the npm wrapper still requires Node.js; explicit online resource operations still require network access.
Foreground view without discovery
planq show project.plan --scale week --focus implementationshow shares dev's local default and preview options. It runs in the foreground until stopped, but does not create the discovery record used by open.
Reopen a running preview
planq open
planq open --scale month --focus release-readyopen validates and reuses the most recent dev session in the current directory, keeping its actual local or site mode. It does not start another server or probe the site. If a record is stale or predates the current implementation, stop the old preview and restart dev.
Manage committed plans on the site
The local workbench's Manage in PlanQ link opens a separate browser page. It does not upload the preview or pass local paths, plan data, or session tokens.
Your .plan files are already saved locally. Commit and push the project to GitHub, then sign in, choose a Workspace, and explicitly connect the read-only GitHub App. GitHub remains the source of truth for committed versions; PlanQ stores synchronized results and workspace management state. See GitHub Sync for manifest, permissions, inspection, and binding requirements.
Data and security boundary
- The server binds to loopback. Site Bridge requests additionally validate the exact site origin and short-lived session token.
- Source files, local IR, and diagnostics are not uploaded by preview.
- The browser reads snapshots and cannot write source files.
- Do not publish a live site Bridge URL; its fragment contains connection data.
- VS Code uses the CLI's bundled local workbench, not another UI inside the VSIX.
- Use
--no-openon remote terminals. Remote SSH, Dev Containers, Codespaces, and automatic port mapping are not supported preview workflows.
For failures, see Preview troubleshooting.