Skip to main content

Swamp Club Lab

@keeb/swamp-club-labv2026.11.04.1· MIT(was none)· 17d agoBEHAVIORS
01README

The swamp-club Lab over its JSON API: read issues with full ripple bodies, events, lifecycle entries and relationships; search; file, edit and close issues; post and edit ripples; wire epics with relationships; and append triage-trail entries. Refuses redirects so a write can never silently no-op.

02Release Notes

Declared schemas for events, lifecycle entries, relationships, search query and assignees (no empty passthrough). Lifecycle body may be null. duplicate_of relationships. search records truncated. 429/503 retries honoring Retry-After. delete of a gone issue succeeds. License and repository declared. No-op upgrade from 2026.09.26.1.

03Behaviors1
@keeb/swamp-club-lab/issuesv2026.11.04.1issues.ts

Global Arguments

ArgumentTypeDescription
apiKeystringPersonal swamp-club API key (`swamp_…`, from ~/.config/swamp/auth.json → apiKey). Collective `swamp_org_…` tokens carry no user session and cannot read issues.
serverUrl?stringLab host. Defaults to https://swamp-club.com. Must be canonical — redirects are refused because a followed 301 silently drops write bodies.
fn get(numbers: array)
Fetch one or more issues with full ripple bodies, events, lifecycle entries and relationships — what `swamp issue get` only counts.
ArgumentTypeDescription
numbersarrayIssue numbers. Fanned out in one execution rather than one run per issue.
fn search(q?: string, source?: string, author?: string, limit?: number, offset?: number, name?: string)
Search and list issues. Only issues visible to this key are returned.
ArgumentTypeDescription
q?stringFree-text query.
source?stringFiling source, e.g. `agent`.
author?stringAuthor username.
limit?number
offset?number
name?stringInstance name for the result. Defaults to `search`, so the latest search overwrites the last.
fn create(title: string, body: string, source?: string)
File an issue. `platform` is admin-only; non-admins file feature, bug or security.
ArgumentTypeDescription
titlestring
bodystringMarkdown.
source?stringFiling source, 1-64 word characters, e.g. `agent`.
fn update(title?: string, body?: string, source?: string, assignees?: array, commentLocked?: boolean, githubPrUrl?: string, githubPrNumber?: number, blocked?: boolean, blockedReason?: string, resolvedInVersion?: string)
Patch an issue. Authors may change title, body, and status to open/closed; admins may change everything, and status verbs drive transitions (triaged, in_progress, shipped). An invalid transition is a 422.
ArgumentTypeDescription
title?string
body?string
source?stringAdmin only.
assignees?arrayUser ids, not usernames. Admin only.
commentLocked?booleanAdmin only.
githubPrUrl?stringAdmin only.
githubPrNumber?numberAdmin only.
blocked?booleanAdmin only.
blockedReason?stringAdmin only.
resolvedInVersion?stringAdmin only. null clears it.
fn delete(confirm: literal)
Hard-delete an issue and everything hanging off it. Admin only, irreversible — run `get` first and confirm the number. An issue that is already gone succeeds.
ArgumentTypeDescription
confirmliteralMust be true. There is no soft delete and no undo.
fn ripple(body: string)
Post a ripple (comment) on an issue. Markdown; profanity is rejected with a 422 naming the flagged words.
ArgumentTypeDescription
bodystring
fn editRipple(commentId: string, body: string)
Replace a ripple's body. Author or admin only.
ArgumentTypeDescription
commentIdstring
bodystring
fn deleteRipple(commentId: string)
Delete a ripple. Author or admin only.
ArgumentTypeDescription
commentIdstring
fn relationships()
List an issue's relationships, each marked `incoming` or `outgoing`. Carries the relationship ids `unrelate` needs.
fn relate(links: array)
Link an issue to others — e.g. wire an epic to its children with `parent_of`. Fans out over every link in one execution.
ArgumentTypeDescription
linksarray
fn unrelate(relationshipId: string)
Remove one relationship by id (from `relationships`). Removing the last blocker unblocks the issue.
ArgumentTypeDescription
relationshipIdstring
fn lifecycle(step: string, summary: string, emoji: string, payload?: record, body?: string, isVerbose?: boolean)
Append a structured triage/lifecycle entry. Admin only — use it only when deliberately driving an issue's lifecycle, never as a comment.
ArgumentTypeDescription
stepstring
summarystring
emojistring
payload?record
body?string
isVerbose?boolean
fn assignees()
List operatives eligible for assignment, with the user ids `update --assignees` takes. Admin only.

Resources

issue(infinite)— One issue with full ripple bodies, events, lifecycle entries and relationships
search(7d)— One page of issue search results
ripple(infinite)— A ripple (comment) as the Lab stored it
relationships(infinite)— An issue's relationships, each marked incoming or outgoing
lifecycleEntry(infinite)— A lifecycle (triage trail) entry as appended
assignees(1d)— Operatives eligible for issue assignment
04Previous Versions1
2026.09.26.1

First publish: Lab issues over the JSON API (get, search, create, update, delete, ripples, relationships, lifecycle, assignees).

05Stats
A
100 / 100
Downloads
4
Archive size
19.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Docs keep secrets in a vault1/1earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
06Platforms
07Labels