Skip to main content

INVITE COMMANDS

The swamp invite command group manages referral links and invitations from the CLI.

Running swamp invite with no subcommand prints group help.


Fetch the operative's referral link, creating one on first use. Idempotent — the same operative always gets the same link.

swamp invite link

Alias: swamp invite rule1

Output: the bare URL is written to stdout and a points note is written to stderr, so swamp invite link | pbcopy captures only the link.

When a new operative signs up through this link and reaches ordinal 5 (Marsh Skulker, 8,000 points), the inviter receives a points payout.

Flag Description
--json Emit {"code": "…", "url": "…"}

Requires authentication (swamp auth login or SWAMP_API_KEY). The referral link is identity-scoped.


swamp invite <address>

Send a per-address email invitation. This command is not yet available — it exits non-zero, prints a notice on stderr, and outputs the operative's referral link as a substitute.

swamp invite user@example.com
Flag Description
--json Emit {"code": "…", "url": "…", "comingSoon": true, "invitedEmail": null}

This behaviour changes when per-address email invitations ship (tracked in lab issue #1376). At that point the command exits 0, the stderr notice is removed, and the comingSoon and invitedEmail JSON fields are dropped.