Skip to main content
← Back to list
01Issue
FeatureShippedSwamp ClubPublic
Assigneesstack72

Relationships

#1778 docs: document --dashboard flag for swamp serve

Opened by stack72 · 8/22/2026· Shipped 8/22/2026

Problem

The --dashboard flag shipped in PR #2208 but has no documentation. Users need to know:

  • How to enable the dashboard (--dashboard flag, SWAMP_DASHBOARD env var, or dashboard: true in serve.yaml)
  • What URL to visit (http://host:port/dashboard)
  • Authentication requirements (same auth as serve — OAuth device flow or token)
  • That it's opt-in and adds no overhead when disabled

Where to document

  1. Serve skill reference (references/serve/guide.md and references/serve/reference.md) — add a Dashboard section covering the flag, config, and access
  2. CLI help text — the --dashboard flag description on serveCommand is brief ("Enable the web dashboard at /dashboard"); consider expanding with a note about the URL
  3. Design doc (design/) — consider a design/dashboard.md capturing the architecture: React SPA, WebSocket protocol, SSE health stream, binary embedding, auth flow
  4. swamp serve daemon enable — as noted in the CLI UX review, --dashboard is missing from the daemon enable subcommand (users who manage serve via the daemon can only enable dashboard through serve.yaml)

CLI UX gap from code review

The code review noted that --dashboard is not mirrored on daemonEnableCommand. Every other serve flag (--hot-reload, --enable-internal-api, --remote-only, etc.) is available on both serve and daemon enable. Fix: add --dashboard to daemonEnableCommand and the collectServeExtraArgs branch.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 2 MOREREVIEW+ 4 MOREPR_MERGED+ 2 MORESESSION_SUMMARIZED

Shipped

8/22/2026, 10:06:13 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack728/22/2026, 9:03:51 PM

Sign in to post a ripple.