ISSUE COMMANDS
The swamp issue command group interacts with swamp-club Lab issues directly
from the CLI.
swamp issue search [query]
Search or list swamp-club Lab issues.
swamp issue search [query]| Argument | Required | Description |
|---|---|---|
query |
No | Search query |
| Flag | Description |
|---|---|
--type <type> |
Filter by issue type: bug, feature, security, platform |
--status <stat> |
Filter by status: open, triaged, in_progress, shipped, closed |
--source <tag> |
Filter by source tag |
--limit <n> |
Maximum results |
swamp issue get <number>
Fetch and display details of a swamp-club Lab issue.
swamp issue get <number>| Argument | Required | Description |
|---|---|---|
number |
Yes | Issue number |
swamp issue edit <number>
Edit the title or body of an issue.
swamp issue edit <number>| Argument | Required | Description |
|---|---|---|
number |
Yes | Issue number |
| Flag | Description |
|---|---|
-t, --title |
New title (skips editor for title) |
-b, --body |
New body (requires --title, skips editor entirely) |
--type <type> |
Change issue type: bug, feature, security (see restrictions) |
--no-redact |
Skip automatic redaction — see Redaction |
Changing to security is a one-way door — only admins can change the type back.
Setting type to platform is admin-only.
swamp issue bug
Submit a bug report.
swamp issue bug| Flag | Description |
|---|---|
-t, --title |
Bug report title |
-b, --body |
Bug report body (requires --title, skips editor) |
-e, --email |
Open email client with pre-filled bug report (mutually exclusive with --extension) |
-x, --extension |
Route the report against a specific extension (e.g., @adam/cfgmgmt; mutually exclusive with --email) |
--repo-dir <dir> |
Repository directory (env: SWAMP_REPO_DIR); only used with --extension |
--no-redact |
Skip automatic redaction — see Redaction |
swamp issue feature
Submit a feature request.
swamp issue feature| Flag | Description |
|---|---|
-t, --title |
Feature request title |
-b, --body |
Feature request body (requires --title, skips editor) |
-e, --email |
Open email client with pre-filled feature request (mutually exclusive with --extension) |
-x, --extension |
Route the request against a specific extension (mutually exclusive with --email) |
--repo-dir <dir> |
Repository directory (env: SWAMP_REPO_DIR); only used with --extension |
--no-redact |
Skip automatic redaction — see Redaction |
swamp issue security
Submit a security report. Security issues are visible only to the author and admins.
swamp issue security| Flag | Description |
|---|---|
-t, --title |
Security report title |
-b, --body |
Security report body (requires --title, skips editor) |
-e, --email |
Open email client with pre-filled security report (mutually exclusive with --extension) |
-x, --extension |
Route the report against a specific extension (mutually exclusive with --email) |
--repo-dir <dir> |
Repository directory (env: SWAMP_REPO_DIR); only used with --extension |
--no-redact |
Skip automatic redaction — see Redaction |
Automatic classification
Every issue filed with swamp issue bug, swamp issue feature,
swamp issue security, or from the Lab page is classified as it is filed.
Classification can change two fields:
| Field | What can change |
|---|---|
| Type | A bug can become a feature and a feature a bug. Either becomes security when the report describes a vulnerability. A security or platform issue never changes. |
| Source | Set to swamp, swamp-club, extensions, or UAT to match what the issue is about. Any other source value never changes. |
A field changes only when the classifier is confident; otherwise the issue keeps
the value it was filed with. An issue moved to security becomes visible only
to its author and admins.
When classification changes an issue, system posts a ripple listing the new
values. To dispute a classification, ripple on the issue.
Redaction
swamp issue bug, feature, security, edit and ripple redact the title
and body before submission. Redaction runs on every submission path: the Lab,
email (--email), and reports routed to an extension (--extension).
| Category | Matched | Replaced with |
|---|---|---|
| Secret | Credentials in connection strings, NAME=value where the name contains PASSWORD, SECRET, TOKEN, API_KEY, PRIVATE_KEY, ACCESS_KEY or AUTH, AWS access key IDs, GitHub tokens, Bearer tokens, label-prefixed keys (sk_live_…, glpat-…), long hex and mixed-case base64 strings, except a git object id (Git object ids) |
[REDACTED-SECRET-N]; [REDACTED-USER]:*** for connection-string credentials |
| Email address | Email addresses | [REDACTED-EMAIL] |
| National ID | XXX-XX-XXXX numbers |
[REDACTED-ID] |
| Credit card | 13–19 digit numbers that pass a Luhn check | [REDACTED-CC] |
| Phone number | Numbers with a + prefix or separators |
[REDACTED-PHONE] |
| Home directory path | The username in /Users/<name>, /home/<name> and C:\Users\<name> |
[REDACTED] |
| IP address | IPv4 addresses, except loopback, link-local and documentation ranges; IPv6 addresses (IPv6 addresses), except ::1 and fe80: link-local |
[IP-N] |
| Hostname | Hosts under internal TLDs (.internal, .local, .lan, .corp, .intranet, .private, .home) and fully qualified domain names with three or more labels |
[HOST-N] |
Public hosts such as github.com, jsr.io, deno.land, swamp-club.com and
example.com are not redacted. Values already masked as *** and shell
references such as ${VAR} are not redacted. Content hashes named by a label
(sha256-…, "checksum": "…") are not redacted.
Numbered placeholders are stable within one submission: the same value maps to the same placeholder everywhere it appears, including across the title and body.
Git object ids
A 40 or 64 character hex string directly after a git word is kept as a git
object id. The git words are commit, sha, rev, git checkout, git show,
git revert, git cherry-pick, git reset, and a /commit/, /commits/,
/tree/ or /blob/ URL segment.
A secret label (token, key, password, secret, auth, credential,
signature, hmac) in the 40 characters before the id still redacts it. Hex
strings of any other length, and ids with no git word before them, are redacted.
commit 3f1c2a9b8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a kept
token 3f1c2a9b8d7e6f5a4b3c2d1e0f9a8b7c6d5e4f3a -> token [REDACTED-SECRET-1]IPv6 addresses
Each colon-joined run of hex groups is judged on its own. A run is an address
when it has eight or more groups, a ::, an embedded IPv4 tail
(2001:db8::192.0.2.1), or six consecutive two-hex groups (a MAC address).
Runs that cannot hold an address are kept: test replay paths
(992:3:11:17:17:12), timestamps, code paths such as std::collections and
AWS::EC2::VPC, and all-zero runs such as passwd fields.
A label ending in one colon (remote_addr:, peer:addr:) stays outside the
placeholder. An address with a port, a message colon, or a unit attached to its
end is redacted whole.
replay path 992:3:11:17:17:12 kept
remote_addr: 2001:db8:85a3:0:0:8a2e:370:7334 -> remote_addr: [IP-1]
mac 00:1a:2b:3c:4d:5e -> mac [IP-2]Before submitting, the command prints a summary and each changed line:
Redacted 2 IP addresses, 1 secret, 1 home directory path, 1 hostname from issue content.
title line 1: Connect to 10.20.30.40 fails -> Connect to [IP-1] fails
body line 1: Ran with API_TOKEN=abc123def456 -> Ran with API_TOKEN=[REDACTED-SECRET-1]
body line 2: host 10.20.30.40 at db01.internal -> host [IP-1] at [HOST-1]
body line 3: path /Users/alice/repo -> path /Users/[REDACTED]/repoNothing is printed when no redaction applies. With --json, the notice is
written to stderr as a redaction object carrying message, total and
changes.
Confirmation
When anything was redacted and stdin is an interactive terminal, the command asks before sending:
y = submit redacted
w = submit as written
N = cancel; nothing is sent (any other answer cancels; --no-redact skips redaction)
Submit? [y/w/N]| Answer | Effect |
|---|---|
y, yes |
Submits the redacted content |
w, written |
Submits the content as written and prints Redaction skipped (chosen at the redaction prompt); content submitted as written. |
| Anything else | Cancels; nothing is sent. Prints Issue creation cancelled, Issue edit cancelled or Ripple cancelled |
The prompt is asked on every submission path, including --email and
--extension. With --json, or when stdin is not a terminal, the redacted
content is submitted without asking.
--no-redact skips redaction and the prompt, and submits the content as
written. The command prints
Redaction skipped (--no-redact); content submitted as written., or
{"redaction":{"skipped":true}} to stderr with --json.
Redaction is pattern-based. It can miss a secret in a format it does not recognise, and it can redact a value that is not sensitive.
swamp issue ripple <number>
Post a comment on an issue. Also available as swamp issue comment.
swamp issue ripple <number>| Argument | Required | Description |
|---|---|---|
number |
Yes | Issue number |
| Flag | Description |
|---|---|
-b, --body |
Ripple body (skips editor) |
--close |
Close the issue after posting |
--reopen |
Reopen the issue after posting |
--no-redact |
Skip automatic redaction — see Redaction |