Agent skill

Fizzy CLI

by basecamp in basecamp/fizzy-cli

Operates Fizzy boards, cards, comments and other resources from the command line, with rules for card numbers, output filtering and checking setup.

MITAuto-check passedProductivity & Automation

Install Fizzy CLI

skills CLI
$ npx skills add basecamp/fizzy-cli --skill fizzy -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install basecamp/fizzy-cli fizzy --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/basecamp/fizzy-cli.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/fizzy .claude/skills/fizzy && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
fizzy
GitHub stars
244
Token cost
~10k tokens
SKILL.md length
2,394 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

Operates Fizzy boards, cards, comments and other resources from the command line, with rules for card numbers, output filtering and checking setup.

  • Works in 8 steps: Cards use NUMBER, not ID — fizzy card… → Use built-in --jq for filtering to… → Check breadcrumbs in responses for… → …
  • Creating, moving or closing cards on a Fizzy board
  • SKILL.md covers Agent Invariants, Decision Trees, Quick Reference and Global Flags, plus 7 more sections
  • Calls git; needs FIZZY_TOKEN

What it does

This skill covers the whole `fizzy` command line tool: boards, cards, columns, comments, steps, reactions, tags, users, notifications, pins, webhooks, account settings, search and board migration. It opens with invariants the agent must follow, such as addressing cards by number rather than ID, filtering output with the built-in `--jq` flag instead of an external jq, and using the breadcrumbs in responses to find next actions.

Further rules: find board context through `.fizzy.yaml` or the `--board` flag before listing cards, run `fizzy doctor` before guessing at setup, config or authentication problems, and remember that card descriptions are strings while comment bodies are nested objects. Rich text fields take markdown or HTML, with a repeatable `--attach` option for inline files. Decision trees guide finding and changing content, and a quick-reference table maps each resource to its list, show, create, update and delete commands.

When your agent uses it

  • Creating, moving or closing cards on a Fizzy board
  • Searching Fizzy for a card by text or listing the cards on a board
  • Adding comments, steps, tags or reactions to existing cards
  • Setting up Fizzy webhooks or changing account settings

Example prompts

  • “Show me all open cards on the Website board with their numbers.”
  • “Move card 42 to the Review column and add a comment saying QA passed.”
  • “Close card 42 and give it a tag called shipped.”
  • “Run the Fizzy doctor check; I think my login is broken.”

Requirements

  • The Fizzy CLI, installed and signed in to a Fizzy account

Workflow steps

8 steps, taken from the first numbered list in SKILL.md.

  1. Cards use NUMBER, not ID — fizzy card show 42 uses the card number. Other resources use their id field.
  2. Use built-in --jq for filtering to reduce token output — fizzy card list --jq '[.data[] | {number, title}]'. Never pipe to external jq…
  3. Check breadcrumbs in responses for available next actions with pre-filled values.
  4. Check for board context via .fizzy.yaml or --board flag before listing cards.
  5. Use fizzy doctor for setup/config/auth issues before guessing — it is the primary read-only health check and includes remediation hints.
  6. Rich text fields accept markdown or HTML — use repeatable --attach PATH for simple end-appended inline attachments, or embed tags manually…
  7. Card description is a string, but comment body is a nested object — .description vs .body.plain_text.
  8. Display the welcome message for new signups — When signup complete --name returns is_new_user: true, you MUST immediately display the…

What it can do on your machine

Read from SKILL.md and the folder at commit 3eb876f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • github.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • FIZZY_TOKEN

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Fizzy CLI loads about 10k tokens when it runs. Until then it costs about 52 tokens; SKILL.md has 2,394 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~52
When it runs · the whole SKILL.md, loaded when a task matches
~10k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from basecamp/fizzy-cli at commit 3eb876f, republished under its MIT licence (© basecamp). 2,394 words, ~10,426 tokens.

Download SKILL.mdSave it as .claude/skills/fizzy/SKILL.md (or your agent's skills folder).
name
fizzy
description
Interact with Fizzy via the Fizzy CLI. Manage boards, cards, columns, comments, steps, reactions, tags, users, notifications, pins, webhooks, and account settings. Use for ANY Fizzy question or action.
triggers
fizzy, /fizzy, fizzy board, fizzy card, fizzy column, fizzy comment, fizzy step, fizzy reaction, fizzy tag, fizzy notification, fizzy webhook, fizzy account…
invocable
true
argument-hint
[action] [args...]

/fizzy - Fizzy Workflow Command

Full CLI coverage: boards, cards, columns, comments, steps, reactions, tags, users, notifications, pins, webhooks, account settings, search, and board migration.

Agent Invariants

MUST follow these rules:

  1. Cards use NUMBER, not ID — fizzy card show 42 uses the card number. Other resources use their id field.
  2. Use built-in --jq for filtering to reduce token output — fizzy card list --jq '[.data[] | {number, title}]'. Never pipe to external jq — use --jq instead. --jq implies --json, no need to pass both.
  3. Check breadcrumbs in responses for available next actions with pre-filled values.
  4. Check for board context via .fizzy.yaml or --board flag before listing cards.
  5. Use fizzy doctor for setup/config/auth issues before guessing — it is the primary read-only health check and includes remediation hints.
  6. Rich text fields accept markdown or HTML — use repeatable --attach PATH for simple end-appended inline attachments, or embed <action-text-attachment> tags manually when exact placement matters.
  7. Card description is a string, but comment body is a nested object — .description vs .body.plain_text.
  8. Display the welcome message for new signups — When signup complete --name returns is_new_user: true, you MUST immediately display the welcome_message field prominently to the user. This is a one-time personal note from the CEO — if you skip it, the user will never see it.

Decision Trees

Finding Content
Need to find something?
├── Know the board? → fizzy card list --board <id>
├── Full-text search? → fizzy search "query"
├── Filter by status? → fizzy card list --indexed-by maybe|closed|not_now|golden|stalled
├── Filter by person? → fizzy card list --assignee <id>
├── Filter by time? → fizzy card list --created today|thisweek|thismonth
└── Cross-board? → fizzy search "query" (searches all boards)
Modifying Content
Want to change something?
├── Move to column? → fizzy card column <number> --column <id>
├── Change status? → fizzy card close|reopen|postpone <number>
├── Assign? → fizzy card assign <number> --user <id>
├── Comment? → fizzy comment create --card <number> --body "text"
├── Add step? → fizzy step create --card <number> --content "text"
└── Move to board? → fizzy card move <number> --to <board_id>

Quick Reference

ResourceListShowCreateUpdateDeleteOther
account-account show-account settings-update-account entropy, account export-create, account export-show EXPORT_ID, account join-code-show, account join-code-reset, account join-code-update
identity-identity show-identity timezone-update --timezone NAME--
boardboard listboard show IDboard createboard update IDboard delete IDboard accesses --board ID, board publish ID, board unpublish ID, board entropy ID, board closed, board postponed, board stream, board involvement ID, migrate board ID
cardcard listcard show NUMBERcard createcard update NUMBERcard delete NUMBERcard move NUMBER, card publish NUMBER, card mark-read NUMBER, card mark-unread NUMBER
searchsearch QUERY-----
activityactivity list----activity list --board ID, activity list --creator ID
columncolumn list --board IDcolumn show ID --board IDcolumn createcolumn update IDcolumn delete IDcolumn move-left ID, column move-right ID
commentcomment list --card NUMBERcomment show ID --card NUMBERcomment createcomment update IDcomment delete IDcomment attachments show --card NUMBER
stepstep list --card NUMBERstep show ID --card NUMBERstep createstep update IDstep delete ID-
reactionreaction list-reaction create-reaction delete ID-
tagtag list-----
useruser listuser show ID-user update ID-user deactivate ID, user role ID, user avatar-remove ID, user export-create USER_ID, user export-show USER_ID EXPORT_ID, user email-change-request USER_ID --email user@example.com, user email-change-confirm USER_ID TOKEN, user push-subscription-create, user push-subscription-delete ID
notificationnotification list----notification tray, notification read-all, notification settings-show, notification settings-update
pinpin list----card pin NUMBER, card unpin NUMBER
webhookwebhook list --board ID, webhook deliveries --board ID WEBHOOK_IDwebhook show ID --board IDwebhook createwebhook update IDwebhook delete IDwebhook reactivate ID

Global Flags

All commands support these global flags unless noted otherwise:

FlagDescription
--token TOKENAPI access token
--profile NAMENamed profile (for multi-account users)
--api-url URLAPI base URL (default: https://app.fizzy.do)
--jq EXPRBuilt-in jq filter for machine-readable JSON output (no external jq required; implies --json, or filters raw data with --quiet/--agent; unsupported on completion, setup, top-level skill, and version with a jq-specific usage error; incompatible with --styled, --markdown, --ids-only, and --count)
--jsonJSON envelope output
--quietRaw JSON data without envelope
--styledHuman-readable styled output (tables, colors)
--markdownGFM markdown output (for agents)
--agentAgent mode (defaults to quiet; combinable with --json/--markdown)
--ids-onlyPrint one ID per line
--countPrint count of results
--limit NClient-side truncation of list results
--verboseShow request/response details

Output format defaults to auto-detection: styled for TTY, JSON for pipes/non-TTY.

Pagination

List commands use --page for pagination and --limit for client-side truncation.

bash
# Get first page (default)
fizzy card list --page 1

# Limit to N results
fizzy card list --limit 5

# Fetch ALL pages at once
fizzy card list --all

Note: --limit and --all cannot be used together.

IMPORTANT: The --all flag controls pagination only - it fetches all pages of results for your current filter. It does NOT change which cards are included. By default, card list returns only open cards. See Card Statuses for how to fetch closed or postponed cards.

Commands supporting --all and --page:

  • board list
  • board closed
  • board postponed
  • board stream
  • card list
  • comment list
  • tag list
  • user list
  • notification list
  • webhook list

Configuration

~/.config/fizzy/              # Global config (or ~/.fizzy/)
└── config.yaml               #   Token, account, API URL, default board

.fizzy.yaml                   # Per-repo config (committed to git)

Per-repo config: .fizzy.yaml

yaml
account: 123456789
board: 03foq1hqmyy91tuyz3ghugg6c

Priority (highest to lowest):

  1. CLI flags (--token, --profile, --api-url, --board)
  2. Environment variables (FIZZY_TOKEN, FIZZY_PROFILE, FIZZY_API_URL, FIZZY_BOARD)
  3. Named profile settings (account, base URL, board from config.json)
  4. Local project config (.fizzy.yaml)
  5. Global config (~/.config/fizzy/config.yaml or ~/.fizzy/config.yaml)

Check context:

bash
cat .fizzy.yaml 2>/dev/null || echo "No project configured"
fizzy config show
fizzy config explain

Setup:

bash
fizzy setup                              # Interactive wizard
fizzy doctor                             # Full install/config/auth/API/agent health check
fizzy auth login TOKEN                   # Save token for current profile
fizzy auth login TOKEN --profile agent --account 1  # Separate identity on account 1
fizzy auth status                        # Check auth status
fizzy auth list                          # List all authenticated profiles
fizzy auth switch PROFILE                # Switch active profile
fizzy auth logout                        # Log out current profile
fizzy auth logout --all                  # Log out all profiles
fizzy identity show                      # Show profiles
Signup (New User or Token Generation)

Interactive:

bash
fizzy signup                                    # Full interactive wizard

Step-by-step (for agents):

bash
# Step 1: Request magic link
fizzy signup start --email user@example.com
# Returns: {"pending_authentication_token": "eyJ..."}

# Step 2: User checks email for 6-digit code, then verify
fizzy signup verify --code ABC123 --pending-token eyJ...
# Returns: {"session_token": "eyJ...", "requires_signup_completion": true/false}
# For existing users (requires_signup_completion=false), also returns: "accounts": [{"name": "...", "slug": "..."}]

# Step 3: Write the session token to a temp file to keep it out of the agent session
echo "eyJ..." > /tmp/fizzy-session && chmod 600 /tmp/fizzy-session

# Step 4a: New user — complete signup (session token via stdin)
fizzy signup complete --name "Full Name" < /tmp/fizzy-session
# Returns: {"token": "fizzy_...", "account": "slug"}

# Step 4b: Existing user — generate token for an account
fizzy signup complete --account SLUG < /tmp/fizzy-session
# Returns: {"token": "fizzy_...", "account": "slug"}

# Step 5: Clean up the temp file
rm /tmp/fizzy-session

Note: The user must check their email for the 6-digit code between steps 1 and 2. The session token is written to a temp file and piped via stdin to avoid exposing it in shell history or the agent's conversation context. Token is saved to the system credential store when available, with a config file as fallback. Profile and API URL are saved to ~/.config/fizzy/ (preferred) or ~/.fizzy/.

Welcome message for new users: When signup complete --name succeeds (new user), the response includes is_new_user: true and a welcome_message field. See Agent Invariant #7 — you MUST display it.


Response Structure

All responses follow this structure:

json
{
  "ok": true,
  "data": { ... },           // Single object or array
  "summary": "4 boards",     // Human-readable description
  "breadcrumbs": [ ... ],    // Contextual next actions (omitted when empty)
  "context": { ... },        // Location, pagination, and other context (omitted when empty)
  "meta": {
  }
}

Summary field formats:

CommandExample Summary
board list"5 boards"
board show ID"Board: Engineering"
card list"42 cards (page 1)" or "42 cards (all)"
card show 123"Card #123: Fix login bug"
search "bug""7 results for "bug""
notification list"8 notifications (3 unread)"

List responses with pagination:

json
{
  "ok": true,
  "data": [ ... ],
  "summary": "10 cards (page 1)",
  "context": {
    "pagination": {
      "has_next": true,
      "next_url": "https://..."
    }
  }
}

Breadcrumbs (contextual next actions):

Responses include a breadcrumbs array suggesting what you can do next. Each breadcrumb has:

  • action: Short action name (e.g., "comment", "close", "assign")
  • cmd: Ready-to-run command with actual values interpolated
  • description: Human-readable description
bash
fizzy card show 42 --jq '.breadcrumbs'
json
[
  {"action": "comment", "cmd": "fizzy comment create --card 42 --body \"text\"", "description": "Add comment"},
  {"action": "triage", "cmd": "fizzy card column 42 --column <column_id>", "description": "Move to column"},
  {"action": "close", "cmd": "fizzy card close 42", "description": "Close card"},
  {"action": "assign", "cmd": "fizzy card assign 42 --user <user_id>", "description": "Assign user"}
]

Use breadcrumbs to discover available actions without memorizing the full CLI. Values like card numbers and board IDs are pre-filled; placeholders like <column_id> need to be replaced.

Create/update responses include location:

json
{
  "ok": true,
  "data": { ... },
  "context": {
    "location": "/6102600/cards/579.json"
  }
}

ID Formats

IMPORTANT: Cards use TWO identifiers:

FieldFormatUse For
id03fe4rug9kt1mpgyy51lq8i5iInternal ID (in JSON responses)
number579CLI commands (card show, card update, etc.)

All card CLI commands use the card NUMBER, not the ID.

Other resources (boards, columns, comments, steps, reactions, users) use their id field.


Card Statuses

Cards exist in different states. By default, fizzy card list returns open cards only (cards in triage or columns). To fetch cards in other states, use the --indexed-by or --column flags:

StatusHow to fetchDescription
Open (default)fizzy card listCards in triage ("Maybe?") or any column
Closed/Donefizzy card list --indexed-by closedCompleted cards
Not Nowfizzy card list --indexed-by not_nowPostponed cards
Goldenfizzy card list --indexed-by goldenStarred/important cards
Stalledfizzy card list --indexed-by stalledCards with no recent activity

You can also use pseudo-columns:

bash
fizzy card list --column done      # Same as --indexed-by closed
fizzy card list --column not-now   # Same as --indexed-by not_now
fizzy card list --column maybe     # Same as --indexed-by maybe

Fetching all cards on a board:

To get all cards regardless of status (for example, to build a complete board view), make separate queries:

bash
# Open cards (triage + columns)
fizzy card list --board BOARD_ID --all

# Closed/Done cards
fizzy card list --board BOARD_ID --indexed-by closed --all

# Optionally, Not Now cards
fizzy card list --board BOARD_ID --indexed-by not_now --all

Built-in jq Filtering

Use --jq for filtering and extracting data. --jq implies --json (or filters raw data with --quiet / --agent) — no need to pass both. Never pipe to external jq — use --jq instead. --jq is for machine-readable JSON output and cannot be combined with --styled, --markdown, --ids-only, or --count.

Reducing Output
bash
# Card summary (most useful)
fizzy card list --jq '[.data[] | {number, title, status, board: .board.name}]'

# First N items from the JSON envelope
fizzy card list --jq '.data[:5]'

# First N items from raw data only
fizzy card list --quiet --jq '.[0:5]'

# Just IDs
fizzy board list --jq '[.data[].id]'

# Specific fields from single item
fizzy card show 579 --jq '.data | {number, title, status, golden}'

# Card with description length (description is a string, not object)
fizzy card show 579 --jq '.data | {number, title, desc_length: (.description | length)}'
Filtering
bash
# Cards with a specific status
fizzy card list --all --jq '[.data[] | select(.status == "published")]'

# Golden cards only
fizzy card list --indexed-by golden --jq '[.data[] | {number, title}]'

# Cards with non-empty descriptions
fizzy card list --jq '[.data[] | select(.description | length > 0) | {number, title}]'

# Cards with steps (must use card show, steps not in list)
fizzy card show 579 --jq '.data.steps'
Extracting Nested Data
bash
# Comment text only (body.plain_text for comments)
fizzy comment list --card 579 --jq '[.data[].body.plain_text]'

# Card description (just .description for cards - it's a string)
fizzy card show 579 --jq '.data.description'

# Step completion status
fizzy card show 579 --jq '[.data.steps[] | {content, completed}]'
Activity Analysis
bash
# Cards with steps count (requires card show for each)
fizzy card show 579 --jq '.data | {number, title, steps_count: (.steps | length)}'

# Comments count for a card
fizzy comment list --card 579 --jq '.data | length'

Command Reference

Identity
bash
fizzy identity show                    # Show your identity and accessible accounts
fizzy identity timezone-update --timezone America/New_York  # Update your timezone for the current account
Account
bash
fizzy account show                     # Show account settings (name, auto-postpone period)
fizzy account entropy --auto_postpone_period_in_days N  # Update account default auto-postpone period (admin only, N: 3, 7, 11, 30, 90, 365)

The auto_postpone_period_in_days is the account-level default. Cards are automatically moved to "Not Now" after this period of inactivity. Each board can override this with board entropy.

Full-text search across cards. The query is sent as a single string to the dedicated search endpoint; if the query exactly matches a card ID, that card is returned directly.

bash
fizzy search QUERY

Examples:

bash
fizzy search "bug"                     # Search for "bug"
fizzy search "login error"             # Single-string FTS query
fizzy search 12345                     # Card-ID lookup shortcut

To filter cards by structured criteria (board, tag, assignee, status, sort, or AND-of-words term filtering), use fizzy card list with --search and the relevant filter flags:

bash
fizzy card list --search "bug" --board BOARD_ID --indexed-by closed --sort newest
Activities
bash
fizzy activity list [--board ID] [--creator ID] [--page N] [--all]
Boards
bash
fizzy board list [--page N] [--all]
fizzy board show BOARD_ID
fizzy board create --name "Name" [--all_access true/false] [--auto_postpone_period_in_days N]
fizzy board update BOARD_ID [--name "Name"] [--all_access true/false] [--auto_postpone_period_in_days N]
fizzy board publish BOARD_ID
fizzy board unpublish BOARD_ID
fizzy board delete BOARD_ID
fizzy board entropy BOARD_ID --auto_postpone_period_in_days N  # N: 3, 7, 11, 30, 90, 365
fizzy board accesses --board ID [--page N]             # Show board access settings and users
fizzy board closed --board ID [--page N] [--all]       # List closed cards
fizzy board postponed --board ID [--page N] [--all]    # List postponed cards
fizzy board stream --board ID [--page N] [--all]       # List stream cards
fizzy board involvement BOARD_ID --involvement LEVEL   # Update your involvement

board show includes public_url only when the board is published. board entropy updates the auto-postpone period for a specific board (overrides account default). Requires board admin.

Board Migration

Migrate boards between accounts (e.g., from personal to team account).

bash
fizzy migrate board BOARD_ID --from SOURCE_SLUG --to TARGET_SLUG [flags]
  --include-images                       # Migrate card header images and inline attachments
  --include-comments                     # Migrate card comments
  --include-steps                        # Migrate card steps (to-do items)
  --dry-run                              # Preview migration without making changes

What gets migrated:

  • Board with same name
  • All columns (preserving order and colors)
  • All cards with titles, descriptions, timestamps, and tags
  • Card states (closed, golden, column placement)
  • Optional: header images, inline attachments, comments, and steps

What cannot be migrated:

  • Card creators (become the migrating user)
  • Card numbers (new sequential numbers in target)
  • Comment authors (become the migrating user)
  • User assignments (team must reassign manually)

Requirements: You must have API access to both source and target accounts. Verify with fizzy identity show.

bash
# Preview migration first
fizzy migrate board BOARD_ID --from personal --to team-account --dry-run

# Basic migration
fizzy migrate board BOARD_ID --from personal --to team-account

# Full migration with all content
fizzy migrate board BOARD_ID --from personal --to team-account \
  --include-images --include-comments --include-steps
Cards
Listing & Viewing
bash
fizzy card list [flags]
  --board ID                           # Filter by board
  --column ID                          # Filter by column ID or pseudo: not-now, maybe, done
  --assignee ID                        # Filter by assignee user ID
  --tag ID                             # Filter by tag ID
  --indexed-by LANE                    # Filter: all, closed, maybe, not_now, stalled, postponing_soon, golden
  --search "terms"                     # Search by text (space-separated for multiple terms)
  --sort ORDER                         # Sort: newest, oldest, or latest (default)
  --creator ID                         # Filter by creator user ID
  --closer ID                          # Filter by user who closed the card
  --unassigned                         # Only show unassigned cards
  --created PERIOD                     # Filter by creation: today, yesterday, thisweek, lastweek, thismonth, lastmonth
  --closed PERIOD                      # Filter by closure: today, yesterday, thisweek, lastweek, thismonth, lastmonth
  --page N                             # Page number
  --all                                # Fetch all pages

fizzy card show CARD_NUMBER            # Show card details (includes steps)
Creating & Updating
bash
fizzy card create --board ID --title "Title" [flags]
  --description "TEXT"                # Card description (markdown or HTML)
  --description_file PATH              # Read description from file (markdown or HTML)
  --attach PATH                        # Upload and append inline attachment at end (repeatable)
  --image SIGNED_ID                    # Header image (use signed_id from upload)
  --tag-ids "id1,id2"                  # Comma-separated tag IDs
  --created-at TIMESTAMP               # Custom created_at

fizzy card update CARD_NUMBER [flags]
  --title "Title"
  --description "TEXT"
  --description_file PATH
  --attach PATH
  --image SIGNED_ID
  --created-at TIMESTAMP

fizzy card delete CARD_NUMBER
Show full SKILL.md (961 more words)Show less
Status Changes
bash
fizzy card close CARD_NUMBER           # Close card (sets closed: true)
fizzy card reopen CARD_NUMBER          # Reopen closed card
fizzy card postpone CARD_NUMBER        # Move to Not Now lane
fizzy card untriage CARD_NUMBER        # Remove from column, back to triage

Note: Card status field stays "published" for active cards. Use:

  • closed: true/false to check if closed
  • --indexed-by not_now to find postponed cards
  • --indexed-by closed to find closed cards
Actions
bash
fizzy card column CARD_NUMBER --column ID     # Move to column (use column ID or: maybe, not-now, done)
fizzy card move CARD_NUMBER --to BOARD_ID     # Move card to a different board
fizzy card assign CARD_NUMBER --user ID       # Toggle user assignment
fizzy card self-assign CARD_NUMBER            # Toggle current user's assignment
fizzy card tag CARD_NUMBER --tag "name"       # Toggle tag (creates tag if needed)
fizzy card watch CARD_NUMBER                  # Subscribe to notifications
fizzy card unwatch CARD_NUMBER                # Unsubscribe
fizzy card pin CARD_NUMBER                    # Pin card for quick access
fizzy card unpin CARD_NUMBER                  # Unpin card
fizzy card golden CARD_NUMBER                 # Mark as golden/starred
fizzy card ungolden CARD_NUMBER               # Remove golden status
fizzy card image-remove CARD_NUMBER           # Remove header image
fizzy card publish CARD_NUMBER               # Publish a card
fizzy card mark-read CARD_NUMBER             # Mark card as read
fizzy card mark-unread CARD_NUMBER           # Mark card as unread
Attachments
bash
fizzy card attachments show CARD_NUMBER [--include-comments]           # List attachments
fizzy card attachments download CARD_NUMBER [INDEX] [--include-comments]  # Download (1-based index)
  -o, --output FILENAME                                    # Exact name (single) or prefix (multiple: test_1.png, test_2.png)
Columns

Boards have pseudo columns by default: not-now, maybe, done

bash
fizzy column list --board ID
fizzy column show COLUMN_ID --board ID
fizzy column create --board ID --name "Name" [--color HEX]
fizzy column update COLUMN_ID --board ID [--name "Name"] [--color HEX]
fizzy column delete COLUMN_ID --board ID
fizzy column move-left COLUMN_ID             # Move column one position left
fizzy column move-right COLUMN_ID            # Move column one position right
Comments
bash
fizzy comment list --card NUMBER [--page N] [--all]
fizzy comment show COMMENT_ID --card NUMBER
fizzy comment create --card NUMBER [--body "TEXT"] [--body_file PATH] [--attach PATH] [--created-at TIMESTAMP]
fizzy comment update COMMENT_ID --card NUMBER [--body "TEXT"] [--body_file PATH] [--attach PATH]
fizzy comment delete COMMENT_ID --card NUMBER
Comment Attachments
bash
fizzy comment attachments show --card NUMBER                  # List attachments in comments
fizzy comment attachments download --card NUMBER [INDEX]      # Download (1-based index)
  -o, --output FILENAME                                       # Exact name (single) or prefix (multiple: test_1.png, test_2.png)
Steps (To-Do Items)

Steps are returned in card show response but can also be listed separately.

bash
fizzy step list --card NUMBER
fizzy step show STEP_ID --card NUMBER
fizzy step create --card NUMBER --content "Text" [--completed]
fizzy step update STEP_ID --card NUMBER [--content "Text"] [--completed] [--not_completed]
fizzy step delete STEP_ID --card NUMBER
Reactions

Reactions can be added to cards directly or to comments on cards.

bash
# Card reactions (react directly to a card)
fizzy reaction list --card NUMBER
fizzy reaction create --card NUMBER --content "emoji"
fizzy reaction delete REACTION_ID --card NUMBER

# Comment reactions (react to a specific comment)
fizzy reaction list --card NUMBER --comment COMMENT_ID
fizzy reaction create --card NUMBER --comment COMMENT_ID --content "emoji"
fizzy reaction delete REACTION_ID --card NUMBER --comment COMMENT_ID
FlagRequiredDescription
--cardYesCard number (always required)
--commentNoComment ID (omit for card reactions)
--contentYes (create)Emoji or text, max 16 characters
Tags

Tags are created automatically when using card tag. List shows all existing tags.

bash
fizzy tag list [--page N] [--all]
Users
bash
fizzy user list [--page N] [--all]
fizzy user show USER_ID
fizzy user update USER_ID --name "Name"       # Update user name (requires admin/owner)
fizzy user update USER_ID --avatar /path.jpg  # Update user avatar
fizzy user deactivate USER_ID                  # Deactivate user (requires admin/owner)
fizzy user role USER_ID --role ROLE            # Update user role (requires admin/owner)
fizzy user avatar-remove USER_ID               # Remove user avatar
fizzy user export-create USER_ID               # Create user data export
fizzy user export-show USER_ID EXPORT_ID       # Show user data export status
fizzy user email-change-request USER_ID --email user@example.com
fizzy user email-change-confirm USER_ID TOKEN
fizzy user push-subscription-create --user ID --endpoint URL --p256dh-key KEY --auth-key KEY
fizzy user push-subscription-delete SUB_ID --user ID
Pins
bash
fizzy pin list                                 # List your pinned cards (up to 100)
Notifications
bash
fizzy notification list [--page N] [--all]
fizzy notification tray                    # Unread notifications (up to 100)
fizzy notification tray --include-read     # Include read notifications
fizzy notification read NOTIFICATION_ID
fizzy notification read-all
fizzy notification unread NOTIFICATION_ID
fizzy notification settings-show              # Show notification settings
fizzy notification settings-update --bundle-email-frequency FREQ  # Update settings
Webhooks

Webhooks notify external services when events occur on a board. Requires account admin access.

bash
fizzy webhook list --board ID [--page N] [--all]
fizzy webhook deliveries --board ID WEBHOOK_ID [--page N] [--all]
fizzy webhook show WEBHOOK_ID --board ID
fizzy webhook create --board ID --name "Name" --url "https://..." [--actions card_published,card_closed,...]
fizzy webhook update WEBHOOK_ID --board ID [--name "Name"] [--actions card_closed,...]
fizzy webhook delete WEBHOOK_ID --board ID
fizzy webhook reactivate WEBHOOK_ID --board ID    # Reactivate a deactivated webhook

Supported actions: card_assigned, card_closed, card_postponed, card_auto_postponed, card_board_changed, card_published, card_reopened, card_sent_back_to_triage, card_triaged, card_unassigned, comment_created

Note: Webhook URL is immutable after creation. Use --actions with comma-separated values.

Webhook Schema
FieldTypeDescription
idstringWebhook ID (use for CLI commands)
namestringWebhook name
payload_urlstringDestination URL
activebooleanWhether webhook is active
signing_secretstringSecret for verifying payloads
subscribed_actionsarrayList of subscribed event actions
created_attimestampISO 8601
urlstringAPI URL
boardobjectNested Board
Account
bash
fizzy account show                                     # Show account settings
fizzy account settings-update --name "Name"            # Update account name
fizzy account export-create                            # Create data export
fizzy account export-show EXPORT_ID                    # Check export status
fizzy account join-code-show                           # Show join code
fizzy account join-code-reset                          # Reset join code
fizzy account join-code-update --usage-limit N         # Update join code limit
File Uploads
bash
fizzy upload file PATH
# Returns: { "signed_id": "...", "attachable_sgid": "..." }
IDUse For
signed_idCard header/background images (--image flag)
attachable_sgidManual inline rich text embedding with <action-text-attachment>

Simple inline attachment mode: prefer --attach PATH on card create, card update, comment create, and comment update when appending attachments at the end is fine.


Common Workflows

Create Card with Steps
bash
# Create the card
CARD=$(fizzy card create --board BOARD_ID --title "New Feature" \
  --description "<p>Feature description</p>" --jq '.data.number')

# Add steps
fizzy step create --card $CARD --content "Design the feature"
fizzy step create --card $CARD --content "Implement backend"
fizzy step create --card $CARD --content "Write tests"
bash
# Add a comment linking the commit
fizzy comment create --card 42 --body "<p>Commit $(git rev-parse --short HEAD): $(git log -1 --format=%s)</p>"

# Close the card when done
fizzy card close 42
Create Card with Inline Attachment

Simple mode:

bash
fizzy card create --board BOARD_ID --title "Bug Report" --description "See the screenshot below" --attach screenshot.png

Advanced/manual placement mode:

bash
# Upload image
SGID=$(fizzy upload file screenshot.png --jq '.data.attachable_sgid')

# Create description file with embedded image
cat > desc.html << EOF
<p>See the screenshot below:</p>
<action-text-attachment sgid="$SGID"></action-text-attachment>
EOF

# Create card
fizzy card create --board BOARD_ID --title "Bug Report" --description_file desc.html
Create Card with Background Image (only when explicitly requested)
bash
# Validate file is an image
MIME=$(file --mime-type -b /path/to/image.png)
if [[ ! "$MIME" =~ ^image/ ]]; then
  echo "Error: Not a valid image (detected: $MIME)"
  exit 1
fi

# Upload and get signed_id
SIGNED_ID=$(fizzy upload file /path/to/header.png --jq '.data.signed_id')

# Create card with background
fizzy card create --board BOARD_ID --title "Card" --image "$SIGNED_ID"
Move Card Through Workflow
bash
# Move to a column
fizzy card column 579 --column maybe

# Assign to yourself
fizzy card self-assign 579

# Or assign to another user
fizzy card assign 579 --user USER_ID

# Mark as golden (important)
fizzy card golden 579

# When done, close it
fizzy card close 579
Move Card to Different Board
bash
# Move card to another board
fizzy card move 579 --to TARGET_BOARD_ID
Search and Filter Cards
bash
# Full-text search
fizzy search "bug" --jq '[.data[] | {number, title}]'

# Filter cards by criteria (use card list, not search)
fizzy card list --search "login" --board BOARD_ID --sort newest

# Find recently created cards
fizzy card list --created today --sort newest

# Find cards closed this week
fizzy card list --indexed-by closed --closed thisweek

# Find unassigned cards
fizzy card list --unassigned --board BOARD_ID
React to a Card
bash
# Add reaction directly to a card
fizzy reaction create --card 579 --content "👍"

# List reactions on a card
fizzy reaction list --card 579 --jq '[.data[] | {id, content, reacter: .reacter.name}]'
Add Comment with Reaction
bash
# Add comment
COMMENT=$(fizzy comment create --card 579 --body "<p>Looks good!</p>" --jq '.data.id')

# Add reaction to the comment
fizzy reaction create --card 579 --comment $COMMENT --content "👍"

Resource Schemas

Complete field reference for all resources. Use these exact field paths in jq queries.

Card Schema

IMPORTANT: card list and card show return different fields. steps only in card show.

FieldTypeDescription
numberintegerUse this for CLI commands
idstringInternal ID (in responses only)
titlestringCard title
descriptionstringPlain text content (NOT an object)
description_htmlstringHTML version with attachments
statusstringUsually "published" for active cards
closedbooleantrue = card is closed
goldenbooleantrue = starred/important
image_urlstring/nullHeader/background image URL
has_attachmentsbooleantrue = card has file attachments
has_more_assigneesbooleanMore assignees than shown
created_attimestampISO 8601
last_active_attimestampISO 8601
urlstringWeb URL
comments_urlstringComments endpoint URL
boardobjectNested Board (see below)
creatorobjectNested User (see below)
assigneesarrayArray of User objects
tagsarrayArray of Tag objects
stepsarrayOnly in card show, not in list
Board Schema
FieldTypeDescription
idstringBoard ID (use for CLI commands)
namestringBoard name
all_accessbooleanAll users have access
auto_postpone_period_in_daysintegerDays of inactivity before cards are auto-postponed
created_attimestampISO 8601
urlstringWeb URL
creatorobjectNested User
Account Settings Schema (from account show)
FieldTypeDescription
idstringAccount ID
namestringAccount name
cards_countintegerTotal cards in account
auto_postpone_period_in_daysintegerAccount-level default auto-postpone period
created_attimestampISO 8601
User Schema
FieldTypeDescription
idstringUser ID (use for CLI commands)
namestringDisplay name
email_addressstringEmail
rolestring"owner", "admin", or "member"
activebooleanAccount is active
created_attimestampISO 8601
urlstringWeb URL
Comment Schema
FieldTypeDescription
idstringComment ID (use for CLI commands)
bodyobjectNested object with html and plain_text
body.htmlstringHTML content
body.plain_textstringPlain text content
created_attimestampISO 8601
updated_attimestampISO 8601
urlstringWeb URL
reactions_urlstringReactions endpoint URL
creatorobjectNested User
cardobjectNested {id, url}
Step Schema
FieldTypeDescription
idstringStep ID (use for CLI commands)
contentstringStep text
completedbooleanCompletion status
Column Schema
FieldTypeDescription
idstringColumn ID or pseudo ID ("not-now", "maybe", "done")
namestringDisplay name
kindstring"not_now", "triage", "closed", or custom
pseudobooleantrue = built-in column
Tag Schema
FieldTypeDescription
idstringTag ID
titlestringTag name
created_attimestampISO 8601
urlstringWeb URL
Reaction Schema
FieldTypeDescription
idstringReaction ID (use for CLI commands)
contentstringEmoji
urlstringWeb URL
reacterobjectNested User
Identity Schema (from identity show)
FieldTypeDescription
accountsarrayArray of Account objects
accounts[].idstringAccount ID
accounts[].namestringAccount name
accounts[].slugstringAccount slug (use with signup complete --account or as profile name)
accounts[].userobjectYour User in this account
Key Schema Differences
ResourceText FieldHTML Field
Card.description (string).description_html (string)
Comment.body.plain_text (nested).body.html (nested)

Rich Text Formatting

Card descriptions and comments support markdown or HTML. For simple inline attachments appended at the end, use --attach PATH.

For exact placement, upload first and embed <action-text-attachment> tags manually. For multiple paragraphs with spacing:

html
<p>First paragraph.</p>
<p><br></p>
<p>Second paragraph with spacing above.</p>

Note: Each attachable_sgid can only be used once. Upload the file again for multiple uses.

Default Behaviors

  • Card images: Use inline (via attachable_sgid in description) by default. Only use background/header (signed_id with --image) when user explicitly says "background" or "header".
  • Comment images: Always inline. Comments do not support background images.

Error Handling

Error response format:

json
{
  "ok": false,
  "error": "Not Found",
  "code": "not_found",
  "hint": "optional context"
}

Exit codes:

CodeMeaning
0Success
1Usage / invalid arguments
2Not found
3Authentication failure
4Permission denied
5Rate limited
6Network error
7API / server error
8Ambiguous match

Authentication errors (exit 3):

bash
fizzy doctor                             # Full health check with hints
fizzy auth status                        # Check auth
fizzy auth list                          # Check which profiles are configured
fizzy auth switch PROFILE                # Switch to correct profile
fizzy auth login TOKEN                   # Re-authenticate
fizzy auth login TOKEN --profile agent --account 1  # Save an aliased profile
fizzy setup                              # Full interactive setup

Not found errors (exit 2): Verify the card number or resource ID is correct. Cards use NUMBER, not ID.

Permission denied (exit 4): Some operations (user update, user deactivate) require admin/owner role.

Network errors (exit 6): Check API URL configuration:

bash
fizzy doctor                             # Full connectivity + API URL diagnostics
fizzy config explain                     # Why this API URL won
fizzy auth status                        # Shows configured profile and API URL

Learn More

© basecamp, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/fizzy of basecamp/fizzy-cli.

Open the folder on GitHubat commit 3eb876f

Compare with similar skills

Fizzy CLI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Fizzy CLI compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Fizzy CLI this skillbasecamp/fizzy-cli244—~10kAutomated safety check: PassMIT
Basecamp Automationdavepoon/buildwithclaude3.6k7 repos~3.1kAutomated safety check: PassMIT
Kanban Mdantopolskiy/kanban-md223—~4kAutomated safety check: PassMIT
Linear Issue Workflowlobehub/lobehub83k—~1.5kAutomated safety check: PassCustom licence
Todo Managerfjrevoredo/mini-diarium308—~1.8kAutomated safety check: PassMIT
Linearkv0906/pm-kit138—~1.9kAutomated safety check: NotesMIT

Similar skills

  • Basecamp Automation

    davepoon/buildwithclaude

    Automate Basecamp project management, to-dos, messages, people, and to-do list organization via Rube MCP (Composio).

    3.6k GitHub starsUsed in 7 repos~3.1k tokens
    Productivity & AutomationAuto-check passed
  • Kanban Md

    antopolskiy/kanban-md

    Manage project tasks using kanban-md, a file-based kanban board CLI.

    223 GitHub stars~4k tokensUpdated 2 days ago
    Productivity & AutomationAuto-check passed
  • Linear Issue Workflow

    lobehub/lobehub

    Handles Linear issues for the team: reading details and images, checking sub-issues, marking progress, labeling AI-created issues and writing completion comments.

    83k GitHub stars~1.5k tokensUpdated today
    Productivity & AutomationAuto-check passed
  • Todo Manager

    fjrevoredo/mini-diarium

    End-to-end management of TODO items in docs/todo/TODO.md. An agent skill from fjrevoredo/mini-diarium.

    308 GitHub stars~1.8k tokensUpdated 2 days ago
    Productivity & AutomationAuto-check passed
  • Linear

    kv0906/pm-kit

    Interact with Linear for issue tracking — search, create, sync, and link issues to vault notes.

    138 GitHub stars~1.9k tokensUpdated 3 mo ago
    Productivity & AutomationAuto-check: notes
  • Linear ticket work through Orca's CLI. Use when working from a linked Linear issue, finishing work with a PR/MR link and a completion comment, moving a ticket…

    87k GitHub stars~558 tokensUpdated today
    Productivity & AutomationAuto-check passed

Works with

Questions about Fizzy CLI

What does Fizzy CLI do?

Operates Fizzy boards, cards, comments and other resources from the command line, with rules for card numbers, output filtering and checking setup. This skill covers the whole `fizzy` command line tool: boards, cards, columns, comments, steps, reactions, tags, users, notifications, pins, webhooks, account settings, search and board migration. It opens with invariants the agent must follow, such as addressing cards by number rather than ID, filtering output with the built-in `--jq` flag instead of an external jq, and using the breadcrumbs in responses to find next actions.

When should I use Fizzy CLI?

Fizzy CLI fits situations like: creating, moving or closing cards on a Fizzy board; searching Fizzy for a card by text or listing the cards on a board; adding comments, steps, tags or reactions to existing cards; setting up Fizzy webhooks or changing account settings.

How do I install Fizzy CLI in Claude Code?

Run `npx skills add basecamp/fizzy-cli --skill fizzy -a claude-code`. Or copy the skill folder (skills/fizzy in basecamp/fizzy-cli) into .claude/skills/fizzy in your project. Claude Code loads it when a task matches its description.

How do I install Fizzy CLI in Codex?

Run `npx skills add basecamp/fizzy-cli --skill fizzy -a codex`. Or copy the skill folder (skills/fizzy in basecamp/fizzy-cli) into .agents/skills/fizzy in your project. Codex loads it when a task matches its description.

Can I use Fizzy CLI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add basecamp/fizzy-cli --skill fizzy -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/fizzy, .gemini/skills/fizzy, .github/skills/fizzy and .opencode/skills/fizzy in your project.

What does Fizzy CLI need to run?

Going by SKILL.md and its folder, Fizzy CLI needs the command-line tools its instructions call (git) and credentials named FIZZY_TOKEN. Our summary lists: The Fizzy CLI, installed and signed in to a Fizzy account.

Does Fizzy CLI access the network?

SKILL.md names 1 domain. As links in the text: github.com. This is read from the text; nothing was executed.

Is Fizzy CLI safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Fizzy CLI use?

Fizzy CLI is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Fizzy CLI use?

About 10k tokens (SKILL.md is roughly 42k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Fizzy CLI?

Skills that share tags, products or a category with Fizzy CLI: Basecamp Automation (davepoon/buildwithclaude, 3.6k stars), Kanban Md (antopolskiy/kanban-md, 223 stars), Linear Issue Workflow (lobehub/lobehub, 83k stars) and Todo Manager (fjrevoredo/mini-diarium, 308 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Fizzy CLI?

basecamp (a GitHub organization) maintains it in basecamp/fizzy-cli, which has 244 GitHub stars. The repository was last updated on September 21, 2026.

Source: basecamp/fizzy-cli on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.