Skip to content

Conversation

@jeremy
Copy link
Member

@jeremy jeremy commented Jan 13, 2026

Introduces fizzy, an agent-first CLI for Fizzy.

Fizzy CLI

  • Foundation: Entry point, config management, API client, OAuth auth flow
  • Queries: boards, cards, columns, people, tags, search, notifications, show
  • Actions: card create, close, reopen, triage, postpone, comment, assign, tag, watch, gild, step
  • Ergonomics: Name resolution, --in alias, multi-origin credential storage, pagination
  • Distribution: Install script, bash/zsh completions, README

Design Highlights

  • Agent-first: JSON envelopes with breadcrumbs, predictable patterns
  • Human-friendly: Markdown output in TTY, rich help text
  • Dependencies: Bash 4+, curl, jq
  • Builds on Minimal modern OAuth 2.1 stack #2296 for seamless auth

Test plan

  • All 256 bats tests pass (bats test/*.bats)
  • Smoke tested against http://fizzy.localhost:3006
  • OAuth flow works (browser and --no-browser modes)
  • Name resolution works across paginated endpoints
  • Card create chains follow-up actions (triage, tag, assign)

Agent-first CLI for Fizzy API interaction:
- OAuth 2.1 with RFC 8414 discovery, DCR, and PKCE
- 7-layer config hierarchy (system/user/repo/local/env/flags)
- HTTP client with ETag caching and exponential backoff
- JSON/Markdown output with auto-detection
- 72 passing bats tests
@jeremy jeremy changed the base branch from main to oauth January 13, 2026 18:13
@jeremy jeremy changed the title Fizzy CLI and OAuth 2.1 support Fizzy CLI Jan 13, 2026
@jeremy jeremy force-pushed the cli branch 4 times, most recently from 6ef263c to b67cf2e Compare January 13, 2026 18:45
Three improvements:

1. _wait_for_callback: Avoid SIGPIPE killing nc before HTTP response sent.
   The `nc | head -1` pipe causes head to close stdin after reading one
   line, sending SIGPIPE to nc before it finishes writing the response.
   Now captures nc output to temp file before reading with head.

2. _exchange_code: Only include client_secret for confidential clients.
   Public clients (registered via DCR) have no secret, and sending an
   empty client_secret= parameter can cause some OAuth servers to reject
   the request.

3. _register_client: Request scope in DCR to ensure CLI gets proper
   permissions.
jeremy added 10 commits January 13, 2026 12:53
The symlink was pointing to $INSTALL_DIR/fizzy but the binary
is at $INSTALL_DIR/bin/fizzy after extraction.
- Tag API returns .title not .name - fix resolve_tag_id matching
- Strip leading # from tag input (users type #bug or bug)
- Use api_get_all for boards/users/tags to fetch all pages
- Use grep -iF in _suggest_similar to avoid regex errors on
  special characters like [ ] *

Adds contract tests for tag resolution and regex handling.
The API only accepts title/description on POST /cards. Flags like
--column, --tag, and --assign were being silently ignored.

Now chains follow-up API calls after card creation:
- POST /cards/{n}/triage for --column
- POST /cards/{n}/taggings for --tag
- POST /cards/{n}/assignments for --assign

Also strips leading # from tag names in fizzy tag --with.
Multi-origin setups (dev + prod) were sharing a global account_slug,
causing mismatches when switching between instances.

Now stores account_slug alongside access_token in per-origin
credentials file, with fallback to global config for compatibility.
- boards, tags, people, notifications: add --page N pagination
- search: add board name resolution via resolve_board_id
- Consistent validation (positive integer required)
- Breadcrumbs show next page command

Adds pagination tests for all query commands.
api_get_all:
- Fall back to ?page=N when Link headers absent
- Stop on empty response to prevent infinite loops

urlencode:
- Replace python3 urllib.parse with jq -sRr @uri
- Removes undocumented Python dependency
Completions:
- Zsh: use \$words[1] in args state (array is shifted)
- Remove --page from global flags (it's per-command)

cards:
- Add postponing_soon to --status filter help + completion
- Global flags (--json, --quiet) must precede command name
- Default base URL is local dev, not production
- Add pagination note for cards command
Adds --all/-a flag to boards, tags, people, and notifications commands
to fetch all pages automatically using api_get_all. When --all is used:
- Summary shows "(all)" instead of page number
- "Next page" breadcrumb is omitted

This matches the Go CLI's full-fetch behavior while maintaining the
per-page --page flag for incremental fetching.

Smoke test notes:
- fizzy boards --all returns all boards (verified with 3 boards)
- fizzy tags --all returns all tags
- fizzy people --all returns all users
- fizzy notifications --all returns all notifications
Adds `fizzy update <number> [options]` to update a card's title or
description. Uses PATCH /cards/{number} endpoint.

Options:
- --title, -t: New card title
- --description, -d: New card description (HTML)
- --description-file: Read description from file

This brings parity with the Go CLI's card update functionality.

Smoke test notes:
- fizzy update 1 --title "New title" updates title
- fizzy update 1 --description "content" updates description
- fizzy update 1 --title "A" --description "B" updates both
- fizzy update 1 --description-file notes.html works
- Error if no options provided (nothing to update)
Changed from standalone commands (fizzy edit-comment, fizzy delete-comment)
to subcommands of comment (fizzy comment edit, fizzy comment delete).

Usage:
  fizzy comment "text" --on <num>      # Create comment (unchanged)
  fizzy comment edit <id> --on <num> "new text"  # Update comment
  fizzy comment delete <id> --on <num>           # Delete comment

API: PATCH/DELETE /cards/:num/comments/:id

Smoke test: fizzy comment edit --help; fizzy comment delete --help
fizzy delete <number> [numbers...]

Permanently deletes cards. Shows warning in help that action cannot be undone.

API: DELETE /cards/:number (returns 204 No Content)

Smoke test: fizzy delete --help
fizzy delete-image <number> removes the header image from a card.
Uses DELETE /cards/:number/image (returns 204), then fetches the
card to show updated state.
Card update: wrap params in {card: {...}} as Rails expects params[:card]

Comment edit: Rails returns 204 No Content on PATCH, so fetch the
updated comment after to get its current state for display.
Steps:
- Add --completed flag to step create
- Add step show/update/delete subcommands
- Fix body wrapper to {step: {...}} as Rails expects

Reactions:
- Add fizzy reactions --card <num> --comment <id> to list reactions
- Add fizzy react delete <id> --card <num> --comment <id>
- Update fizzy react to manage reactions (add + delete)

All commands follow existing subcommand patterns (like comment edit/delete).
Shell completions updated for new subcommands.
Identity & Users:
- fizzy identity: show current user and accounts
- fizzy user show/update/delete: manage users
- User avatar upload via multipart form

Card Images:
- --image flag on card create and card update
- Multipart upload with retry/backoff for 429/5xx
- Use --form-string for non-file fields (prevents @-prefix hazard)

Auth & Config:
- FIZZY_URL convenience var (extracts base URL + account slug)
- Allow re-login without logout
- Improved token and scope handling

Reliability:
- api_multipart_request helper with retry logic
- Regression test for --form-string usage

387 tests passing, smoke tested against live server.
@jeremy jeremy mentioned this pull request Jan 14, 2026
4 tasks
jeremy added 16 commits January 14, 2026 14:27
Adds Jbuilder views for index, show, and create actions.
Internal endpoints (Tier 3) - functional but intentionally undocumented.
- Fix card create/update params (remove status, tag_ids)
- Fix card move request shape (top-level board_id)
- Fix board update request (top-level user_ids)
- Fix comment update response (204 No Content)
- Fix column reordering paths (shallow routes)
- Add 429 to error codes table
- Add endpoint-specific error table
- Add API docs maintenance micro-skill
- Align webhook actions with PERMITTED_ACTIONS
Documents API↔CLI coverage and intentional omissions (pins, involvement).
- fizzy webhooks: list webhooks
- fizzy webhook create/show/update/delete
- Align available actions with Webhook::PERMITTED_ACTIONS
- Add assert_json_contains test helper
- Add 17 webhook tests including action list lock tests
- fizzy account show/update/entropy/join-code/export
- Export accepts HTTP 202 for async operations
- fizzy --version / -V / version: show installed version
- fizzy self-update: update CLI from GitHub
- fizzy self-update --check: check without installing
- Add VERSION file for semver tracking
- Add 9 tests for version and self-update
- fizzy board publish: publish board publicly with shareable URL
- fizzy board unpublish: remove public access
- fizzy board entropy: set auto-postpone period
- Use publish response URL correctly
- fizzy user role: change user role (owner/admin/member)
- fizzy card publish: publish draft card
- fizzy card move --to: move card to different board
- Add webhooks, account to help topics
- Update command listings for new subcommands
- Fix unbound variable EXIT_API_ERROR (was EXIT_API)
- Guard against self-update in git checkouts (suggest git pull)
- Guard against non-writable FIZZY_ROOT (suggest brew upgrade)
- Add tests for git checkout detection
Version tracking changes:
- Remove VERSION file (no manual version bumping)
- Install script fetches latest commit SHA from GitHub API
- Write commit SHA to .commit file during install
- Display version as "fizzy main (abc1234)" format
- self-update compares commits instead of version strings

Uninstall command:
- fizzy uninstall shows what will be removed
- fizzy uninstall --force removes installation and symlinks
- Guards for git checkout and Homebrew installs
- Removes symlink from common bin directories
Install script improvements:
- Support FIZZY_REPO, FIZZY_REF, FIZZY_COMMIT env vars for forks/CI
- Try branch then tag when downloading (supports both refs/heads and refs/tags)
- Gracefully handle GitHub API rate limits (commit SHA is best-effort)
- Add 5s timeout to API calls to avoid hanging

Self-update improvements:
- --force now works even when GitHub API is unavailable
- Better error messages suggesting --force when rate-limited
- Re-try commit SHA fetch after download in _perform_update
- Fall back to branch name in .commit if SHA unavailable
- Use FIZZY_BRANCH in status messages instead of hardcoded "main"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants