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

#372 Docs: update doctor reference and autoupdate how-to for new doctor install subcommand

Opened by stack72 · 5/18/2026· Shipped 5/18/2026

Context

PR for swamp-club#368 adds a new swamp doctor install subcommand that reports installation health (binary path, owner, writability, autoupdate status).

Documentation gaps

  1. Reference: content/manual/reference/doctor.md — needs a new section documenting swamp doctor install, its output fields, and exit codes (0 = healthy, 1 = unhealthy).

  2. How-to: content/manual/how-to/set-up-background-autoupdating.md — should mention swamp doctor install as a diagnostic tool when autoupdate isn't working. The guide currently doesn't cover troubleshooting a misconfigured autoupdate (e.g. root-owned binary).

What changed

  • New subcommand: swamp doctor install
  • Log mode: human-readable health check with HEALTHY/UNHEALTHY status
  • JSON mode: structured InstallHealthReport with overallStatus field
  • Works outside a swamp repo (no --repo-dir needed)
  • Inline permission warning now references swamp doctor install
  • --setup-auto now blocks when running as root (POSIX)
02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 5 MOREREVIEW+ 3 MOREPR_MERGEDCOMPLETE

Shipped

5/18/2026, 11:46:58 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack725/18/2026, 11:12:20 PM

Sign in to post a ripple.