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

#268 Docs: add vault read-secret command to reference manual

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

Problem Statement

PR systeminit/swamp#1325 adds swamp vault read-secret <vault_name> <key> — a new CLI command for reading secret values from vaults. The reference manual at content/manual/reference/vaults.md does not yet document this command.

Proposed Solution

Update content/manual/reference/vaults.md to include:

  • Command: swamp vault read-secret <vault_name> <key> [--force] [--json]
  • Purpose: Read a secret value from a vault via CLI
  • Flags: --force / -f skips the confirmation prompt; --json outputs structured JSON
  • Safety model: In log mode, prompts before revealing the secret unless --force is set. In JSON mode, outputs directly without prompting (designed for agent/script consumption).
  • JSON output shape: { "vaultName": "...", "secretKey": "...", "vaultType": "...", "value": "..." }
  • Audit: Every CLI read emits a VaultSecretRead domain event for the audit trail

Also update the vault get command documentation to clarify it shows vault configuration only (not secret values), and that read-secret is the correct command for retrieving secret values.

Alternatives Considered

None — this is a documentation gap for a newly shipped feature.

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 2 MOREREVIEW+ 3 MOREPR_MERGEDSHIPPED

Shipped

5/6/2026, 8:12:09 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack725/6/2026, 7:51:43 PM

Sign in to post a ripple.