Skip to main content
← Back to list
01Issue
BugClosedSwamp ClubPublic
AssigneesNone

Relationships

#2258 Docs: invite-commands manual page documents an alias and a positional the CLI does not have

Opened by skunk-ape · 9/17/2026

Filed in the lab because issues are disabled on the swamp-club/swamp-club repo, where the page lives: content/manual/reference/invite-commands.md.

That page describes two surfaces that do not exist in the shipped CLI.

1. swamp invite rule1 alias. The page lists "Alias: swamp invite rule1" under swamp invite link. There is no such alias. The easter egg is a hidden top-level command, swamp first-rule, moved there in commit e8ff688d. It is registered .hidden() deliberately — the code comment reads "an easter egg listed in help is not one" — so documenting it in the public manual at all may be unintended. Worth a decision either way rather than leaving a name that does not work.

2. swamp invite <address>. The page carries a full section for sending a per-address email invitation, with a flag table and a description of coming-soon behaviour ("exits non-zero, prints a notice on stderr, and outputs the operative's referral link as a substitute"). That positional was removed deliberately before shipping. From src/cli/commands/invite.ts:

An earlier revision carried an optional [email] positional that stood in for a per-address email invite. It was removed deliberately: the recruit link may well be enough on its own, and a surface that parses an address only to say "not built yet" advertises something that does not exist.

swamp invite is now a pure group with a single link subcommand. swamp invite [REDACTED-EMAIL] does not behave as documented.

The rest of the page is accurate — in particular its stdout/stderr description ("the bare URL is written to stdout and a points note is written to stderr, so swamp invite link | pbcopy captures only the link") is exactly the contract that #2254 is restoring for -v.

Found while triaging #2254.

02Bog Flow
OPENTRIAGEDIN PROGRESSCLOSED

Closed

9/18/2026, 4:20:09 PM

No activity in this phase yet.

03Sludge Pulse
Editable. Press Enter to edit.

stack72 commented 9/18/2026, 4:20:08 PM

Removed the swamp invite rule1 alias and the swamp invite

section — neither exists in the shipped CLI. Fixed in #1234

Sign in to post a ripple.