Skip to content

Local preview ​

PlanQ previews saved plan files in the hosted workbench without uploading the source. The CLI starts a local server and opens a URL containing a short-lived token and protocol info in the URL fragment. Since it's in the fragment, this data never reaches the hosted server.

Persistent preview ​

bash
planq dev project.plan

dev watches the entry, its includes, and shared resource files. Each valid save refreshes the same browser view. Invalid saves display diagnostics while preserving the last valid Gantt result.

Use a fixed port or suppress browser launch:

bash
planq dev project.plan --port 4173 --no-open

Press Ctrl+C to stop the Bridge and remove its session discovery file.

One-session preview ​

bash
planq show project.plan --scale week --focus implementation

show accepts explicit entries and optional initial view settings. It does not create the persistent discovery state used by open.

Reopen a running preview ​

bash
planq open
planq open --scale month --focus release-ready

open reuses the most recent live planq dev session. If the session is stale, it will let you know instead of loading an unrelated page.

Data and security boundary ​

  • The Bridge binds to loopback and validates the site origin and session token.
  • .plan, resource files, and generated IR stay on the local machine.
  • The browser receives read-only snapshots and cannot write source files.
  • Do not publish or paste a live Bridge URL; its fragment contains session connection data.
  • Use --no-open on remote terminals. Port forwarding and remote editor containers are not currently an official workflow.

An explicit but invalid Bridge URL remains a source error in the workbench. It does not fall back to the hosted example or show example activation actions. If something goes wrong, just start a fresh planq dev session instead of trying to manually edit or share the URL.

For connection failures, see Preview troubleshooting.

PlanQ documentation