workspace

welcome-workspace docs

FeaturesInstall

Get it running

Five minutes if Node and pnpm are already on the machine. Add a root, watch the scan.

Needs

  • Node 22+
  • pnpm
  • git on PATH
  • Optional: gio so the file browser can trash instead of permanently delete

Install & run

git clone git@github.com:DimitriGilbert/workspace-welcome.git
cd workspace-welcome
pnpm install
pnpm dev

Open http://localhost:37420. Gear icon → add a directory. Projects show up as the scan runs. Prefer only the app with pnpm dev:web — port is set in apps/web/vite.config.ts (37420).

First IDE open

“Open IDE” on a project page downloads code-server into the app data dir (~100–200 MB, once). After that it is a shared instance — deep-link per project, stop from Settings.

Where state lives

  • Config / roots / pins / notes: $XDG_CONFIG_HOME/workspace-welcome/store.json
  • Report HTML: $XDG_CACHE_HOME/workspace-welcome/reports/
  • code-server install: $XDG_DATA_HOME/workspace-welcome/ide/

More on knobs and paths: Settings & data.

For the nerds

pnpm monorepo. apps/web is TanStack Start (UI + server routes). packages/api holds tRPC plus the scanner, git, scaffold, and IDE bits. packages/ui is the shared kiln kit this site reuses. Scaffolded with Better-T-Stack. No auth, no ORM, no database.

FeaturesConcepts