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

Relationships

#490 Docs: document swamp doctor secrets in manual reference doctor.md

Opened by stack72 · 5/29/2026· Shipped 5/30/2026

Problem

swamp-club#483 adds a new CLI subcommand, swamp doctor secrets, but the manual reference (content/manual/reference/doctor.md) does not mention it. Users have no documentation for the command.

Proposed solution

Add a swamp doctor secrets section to doctor.md alongside audit / extensions / install / workflows, documenting:

  • What it does: read-only scan reporting model definitions whose sensitive: true global arguments hold a cleartext literal value (instead of a vault.get(...) expression). It is the detection complement to the at-rest write guard (swamp-club#480).
  • Coverage: scans models/ (including datastore-synced definitions) and .swamp/auto-definitions.
  • Output: reports each finding with value-free swamp vault put + vault.get remediation guidance; never prints the secret value; exits non-zero when any leak is found (CI-gateable); advisory 'could not be assessed' warning for definitions whose extension type is not installed.
  • Modes: both log and --json (json shape: { overallStatus, scanned, findings, unresolved }).

Alternatives

The PR ships design/doctor-secrets.md (internal design doc), but user-facing manual coverage is still needed.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 5 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

5/30/2026, 1:06:11 AM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack725/30/2026, 12:32:09 AM

Sign in to post a ripple.