Skip to content

Quickstart

Copy page

Node ≥ 20 required.

Terminal window
npm i -g @plandesk/cli
plandesk init
plandesk serve

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

To hack on the monorepo instead of using the published CLI:

Terminal window
git clone https://github.com/asyncdotengineering/plandesk
cd plandesk
pnpm install && pnpm build
export PATH="$PWD/packages/plandesk-cli/bin:$PATH"
plandesk init
plandesk serve

Import a sample checkout-revamp plan (canvas, labeled edges, linked docs, agent run):

Terminal window
plandesk import --in examples/checkout-revamp.json

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

From a cloned repo:

Terminal window
pnpm build # compile all packages + web assets
pnpm test # unit + integration tests
pnpm lint # ESLint + Prettier
pnpm format # apply Prettier