welcome-workspace docs

FeaturesInstall

Settings & data

Knobs in the UI, paths on disk. Nothing here leaves the machine that runs the app.

In Settings

  • Add / remove roots. Removing a root drops overrides under it.
  • Restore hidden projects.
  • Editor command (code, cursor, zed, …).
  • Terminal command — or leave empty and let it pick the first it finds from common Linux terminals (konsole, gnome-terminal, kitty, alacritty, and friends).
  • git-snitch command path (local build preferred, npx fallback).
  • Per-root comparative report button.
  • IDE status + stop for the shared code-server instance.

On disk

WhatWhere
Roots, pins, notes, hide, open commands$XDG_CONFIG_HOME/workspace-welcome/store.json
Report HTML cache$XDG_CACHE_HOME/workspace-welcome/reports/
code-server install$XDG_DATA_HOME/workspace-welcome/ide/

On most Linux boxes that is under ~/.config, ~/.cache, and ~/.local/share. Store writes are atomic.

Trust boundary

The app is fine on localhost or a trusted LAN. The IDE runs with --auth none. File routes reject path escapes. Still: do not hang this on the public internet and walk away. It is a tool for your network, not a fortress.