Quickstart
Copy page
Node ≥ 20 required.
Install from npm
Section titled “Install from npm”npm i -g @plandesk/cliplandesk initplandesk serveOpen http://127.0.0.1:7526. Create a project in the UI, or import the dogfood fixture below.
The workspace database defaults to the machine-global board at ~/.plandesk/workspace.db (one board per machine; not committed). plandesk init --local-db opts into a repo-local .plandesk/workspace.db. Commands that open a workspace prefer an existing repo-local db if present, otherwise the global board. Override with --data-dir or PLANDESK_DATA_DIR.
Want a hosted instance? Local mode needs no account. To run Plan Desk as a shared cloud service (browser sign-in with GitHub, agents connect with a scoped token), see Self-Hosting → Cloudflare Workers and the topologies overview.
Install from source (contributors)
Section titled “Install from source (contributors)”To hack on the monorepo instead of using the published CLI:
git clone https://github.com/asyncdotengineering/plandeskcd plandeskpnpm install && pnpm buildexport PATH="$PWD/packages/plandesk-cli/bin:$PATH"plandesk initplandesk serveDogfood demo
Section titled “Dogfood demo”Import a sample checkout-revamp plan (canvas, labeled edges, linked docs, agent run):
plandesk import --in examples/checkout-revamp.jsonThe command prints the new project UUID. Open it in the UI, then run plandesk connect --project "Checkout Revamp" from a repo to let an agent inspect and update tasks over MCP.
Next steps
Section titled “Next steps”- Your first project — plan on the canvas, attach specs, use the board
- From idea to development with Claude Code — let Claude plan it, then build it from the live plan
- Plan & execute a project — connect an agent and work from the live plan
Development
Section titled “Development”From a cloned repo:
pnpm build # compile all packages + web assetspnpm test # unit + integration testspnpm lint # ESLint + Prettierpnpm format # apply Prettier