Fizzy CLI Skill
Fizzy CLI 技能
Manage Fizzy boards, cards, steps, comments, and reactions.
| Resource | List | Show | Create | Update | Delete | Other |
|---|
| board | | | | | | |
| card | | | | | | |
| search | | - | - | - | - | - |
| column | | column show ID --board ID
| | | | - |
| comment | comment list --card NUMBER
| comment show ID --card NUMBER
| | | | - |
| step | - | step show ID --card NUMBER
| | | | - |
| reaction | | - | | - | | - |
| tag | | - | - | - | - | - |
| user | | | - | - | - | - |
| notification | | - | - | - | - | - |
| 资源 | 列表 | 详情 | 创建 | 更新 | 删除 | 其他 |
|---|
| 看板 | | | | | | |
| 卡片 | | | | | | |
| 搜索 | | - | - | - | - | - |
| 列 | | column show ID --board ID
| | | | - |
| 评论 | comment list --card NUMBER
| comment show ID --card NUMBER
| | | | - |
| 步骤 | - | step show ID --card NUMBER
| | | | - |
| 互动 | | - | | - | | - |
| 标签 | | - | - | - | - | - |
| 用户 | | | - | - | - | - |
| 通知 | | - | - | - | - | - |
IMPORTANT: Cards use TWO identifiers:
| Field | Format | Use For |
|---|
| 03fe4rug9kt1mpgyy51lq8i5i
| Internal ID (in JSON responses) |
| | CLI commands (, , etc.) |
All card CLI commands use the card NUMBER, not the ID.
Other resources (boards, columns, comments, steps, reactions, users) use their
field.
重要提示: 卡片使用两种标识符:
| 字段 | 格式 | 用途 |
|---|
| 03fe4rug9kt1mpgyy51lq8i5i
| 内部ID(仅在JSON响应中使用) |
| | CLI命令使用(如、等) |
所有卡片CLI命令均使用卡片NUMBER,而非ID。
其他资源(看板、列、评论、步骤、互动、用户)使用其
字段。
All responses follow this structure:
json
{
"success": true,
"data": { ... }, // Single object or array
"summary": "4 boards", // Human-readable description
"breadcrumbs": [ ... ], // Contextual next actions (omitted when empty)
"meta": {
"timestamp": "2026-01-12T21:21:48Z"
}
}
Summary field formats:
| Command | Example Summary |
|---|
| "5 boards" |
| "Board: Engineering" |
| "42 cards (page 1)" or "42 cards (all)" |
| "Card #123: Fix login bug" |
| "7 results for "bug"" |
| "8 notifications (3 unread)" |
List responses with pagination:
json
{
"success": true,
"data": [ ... ],
"summary": "10 cards (page 1)",
"pagination": {
"has_next": true,
"next_url": "https://..."
},
"meta": { ... }
}
Breadcrumbs (contextual next actions):
Responses include a
array suggesting what you can do next. Each breadcrumb has:
- : Short action name (e.g., "comment", "close", "assign")
- : Ready-to-run command with actual values interpolated
- : 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
need to be replaced.
Error responses:
json
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Not Found",
"status": 404
},
"meta": { ... }
}
Create/update responses include location:
json
{
"success": true,
"data": { ... },
"location": "/6102600/cards/579.json",
"meta": { ... }
}
所有响应均遵循以下结构:
json
{
"success": true,
"data": { ... }, // 单个对象或数组
"summary": "4 boards", // 人类可读的描述
"breadcrumbs": [ ... ], // 上下文后续操作(为空时省略)
"meta": {
"timestamp": "2026-01-12T21:21:48Z"
}
}
Summary字段格式:
| 命令 | 示例Summary |
|---|
| "5个看板" |
| "看板:工程" |
| "42张卡片(第1页)" 或 "42张卡片(全部)" |
| "卡片#123:修复登录漏洞" |
| "7条关于"bug"的结果" |
| "8条通知(3条未读)" |
带分页的列表响应:
json
{
"success": true,
"data": [ ... ],
"summary": "10张卡片(第1页)",
"pagination": {
"has_next": true,
"next_url": "https://..."
},
"meta": { ... }
}
Breadcrumbs(上下文后续操作):
响应包含
数组,提示您接下来可以执行的操作。每个breadcrumb包含:
- : 简短操作名称(如"comment"、"close"、"assign")
- : 可直接运行的命令,已插入实际值
- : 人类可读的描述
bash
fizzy card show 42 | jq '.breadcrumbs'
json
[
{"action": "comment", "cmd": "fizzy comment create --card 42 --body \"text\"", "description": "添加评论"},
{"action": "triage", "cmd": "fizzy card column 42 --column <column_id>", "description": "移动到指定列"},
{"action": "close", "cmd": "fizzy card close 42", "description": "关闭卡片"},
{"action": "assign", "cmd": "fizzy card assign 42 --user <user_id>", "description": "分配给用户"}
]
使用breadcrumbs可以发现可用操作,无需记住完整的CLI命令。卡片编号和看板ID等值已预先填充;
等占位符需要替换。
错误响应:
json
{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "未找到",
"status": 404
},
"meta": { ... }
}
创建/更新响应包含位置信息:
json
{
"success": true,
"data": { ... },
"location": "/6102600/cards/579.json",
"meta": { ... }
}
Complete field reference for all resources. Use these exact field paths in jq queries.
所有资源的完整字段参考。在jq查询中请使用这些精确的字段路径。
IMPORTANT: and
return different fields.
only in
.
| Field | Type | Description |
|---|
| integer | Use this for CLI commands |
| string | Internal ID (in responses only) |
| string | Card title |
| string | Plain text content (NOT an object) |
| string | HTML version with attachments |
| string | Usually "published" for active cards |
| boolean | true = card is closed |
| boolean | true = starred/important |
| string/null | Header/background image URL |
| boolean | More assignees than shown |
| timestamp | ISO 8601 |
| timestamp | ISO 8601 |
| string | Web URL |
| string | Comments endpoint URL |
| object | Nested Board (see below) |
| object | Nested User (see below) |
| array | Array of User objects |
| array | Array of Tag objects |
| array | Only in , not in list |
| 字段 | 类型 | 描述 |
|---|
| 整数 | CLI命令使用此字段 |
| 字符串 | 内部ID(仅在响应中使用) |
| 字符串 | 卡片标题 |
| 字符串 | 纯文本内容(不是对象) |
| 字符串 | 带附件的HTML版本 |
| 字符串 | 活跃卡片通常为"published" |
| 布尔值 | true = 卡片已关闭 |
| 布尔值 | true = 已标星/重要 |
| 字符串/null | 页眉/背景图片URL |
| 布尔值 | 存在未显示的更多被分配人 |
| 时间戳 | ISO 8601格式 |
| 时间戳 | ISO 8601格式 |
| 字符串 | 网页URL |
| 字符串 | 评论端点URL |
| 对象 | 嵌套的看板对象(见下文) |
| 对象 | 嵌套的用户对象(见下文) |
| 数组 | 用户对象数组 |
| 数组 | 标签对象数组 |
| 数组 | 仅在中返回,列表中不包含 |
| Field | Type | Description |
|---|
| string | Board ID (use for CLI commands) |
| string | Board name |
| boolean | All users have access |
| timestamp | ISO 8601 |
| string | Web URL |
| object | Nested User |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 看板ID(CLI命令使用此字段) |
| 字符串 | 看板名称 |
| 布尔值 | 所有用户都有访问权限 |
| 时间戳 | ISO 8601格式 |
| 字符串 | 网页URL |
| 对象 | 嵌套的用户对象 |
| Field | Type | Description |
|---|
| string | User ID (use for CLI commands) |
| string | Display name |
| string | Email |
| string | "owner", "admin", or "member" |
| boolean | Account is active |
| timestamp | ISO 8601 |
| string | Web URL |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 用户ID(CLI命令使用此字段) |
| 字符串 | 显示名称 |
| 字符串 | 邮箱 |
| 字符串 | "owner"、"admin"或"member" |
| 布尔值 | 账户处于活跃状态 |
| 时间戳 | ISO 8601格式 |
| 字符串 | 网页URL |
| Field | Type | Description |
|---|
| string | Comment ID (use for CLI commands) |
| object | Nested object with html and plain_text |
| string | HTML content |
| string | Plain text content |
| timestamp | ISO 8601 |
| timestamp | ISO 8601 |
| string | Web URL |
| string | Reactions endpoint URL |
| object | Nested User |
| object | Nested {id, url} |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 评论ID(CLI命令使用此字段) |
| 对象 | 包含html和plain_text的嵌套对象 |
| 字符串 | HTML内容 |
| 字符串 | 纯文本内容 |
| 时间戳 | ISO 8601格式 |
| 时间戳 | ISO 8601格式 |
| 字符串 | 网页URL |
| 字符串 | 互动端点URL |
| 对象 | 嵌套的用户对象 |
| 对象 | 嵌套的{id, url}对象 |
| Field | Type | Description |
|---|
| string | Step ID (use for CLI commands) |
| string | Step text |
| boolean | Completion status |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 步骤ID(CLI命令使用此字段) |
| 字符串 | 步骤文本 |
| 布尔值 | 完成状态 |
| Field | Type | Description |
|---|
| string | Column ID or pseudo ID ("not-now", "maybe", "done") |
| string | Display name |
| string | "not_now", "triage", "closed", or custom |
| boolean | true = built-in column |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 列ID或伪ID("not-now"、"maybe"、"done") |
| 字符串 | 显示名称 |
| 字符串 | "not_now"、"triage"、"closed"或自定义 |
| 布尔值 | true = 内置列 |
| Field | Type | Description |
|---|
| string | Tag ID |
| string | Tag name |
| timestamp | ISO 8601 |
| string | Web URL |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 标签ID |
| 字符串 | 标签名称 |
| 时间戳 | ISO 8601格式 |
| 字符串 | 网页URL |
| Field | Type | Description |
|---|
| string | Reaction ID (use for CLI commands) |
| string | Emoji |
| string | Web URL |
| object | Nested User |
| 字段 | 类型 | 描述 |
|---|
| 字符串 | 互动ID(CLI命令使用此字段) |
| 字符串 | 表情符号 |
| 字符串 | 网页URL |
| 对象 | 嵌套的用户对象 |
| Field | Type | Description |
|---|
| array | Array of Account objects |
| string | Account ID |
| string | Account name |
| string | Account slug (use with --account) |
| object | Your User in this account |
| 字段 | 类型 | 描述 |
|---|
| 数组 | 账户对象数组 |
| 字符串 | 账户ID |
| 字符串 | 账户名称 |
| 字符串 | 账户别名(与--account参数一起使用) |
| 对象 | 您在此账户中的用户信息 |
Key Schema Differences
关键架构差异
| Resource | Text Field | HTML Field |
|---|
| Card | (string) | (string) |
| Comment | (nested) | (nested) |
| 资源 | 文本字段 | HTML字段 |
|---|
| 卡片 | (字符串) | (字符串) |
| 评论 | (嵌套) | (嵌套) |
All commands support:
| Flag | Description |
|---|
| Account slug (for multi-account users) |
| Pretty-print JSON output |
| Show request/response details |
所有命令均支持:
| 标志 | 描述 |
|---|
| 账户别名(针对多账户用户) |
| 格式化输出JSON |
| 显示请求/响应详情 |
List commands use
for pagination. There is NO
flag.
Get first page (default)
获取第一页(默认)
Get specific number of results using jq
使用jq获取指定数量的结果
fizzy card list --page 1 | jq '.data[:5]'
fizzy card list --page 1 | jq '.data[:5]'
Fetch ALL pages at once
一次性获取所有页面
fizzy card list --all
Commands supporting `--all` and `--page`:
- `board list`
- `card list`
- `search`
- `comment list`
- `tag list`
- `user list`
- `notification list`
---
fizzy card list --all
支持`--all`和`--page`的命令:
- `board list`
- `card list`
- `search`
- `comment list`
- `tag list`
- `user list`
- `notification list`
---
Card summary (most useful)
卡片摘要(最实用)
fizzy card list | jq '[.data[] | {number, title, status, board: .board.name}]'
fizzy card list | jq '[.data[] | {number, title, status, board: .board.name}]'
fizzy card list | jq '.data[:5]'
fizzy card list | jq '.data[:5]'
fizzy board list | jq '[.data[].id]'
fizzy board list | jq '[.data[].id]'
Specific fields from single item
单个条目的指定字段
fizzy card show 579 | jq '.data | {number, title, status, golden}'
fizzy card show 579 | jq '.data | {number, title, status, golden}'
Card with description length (description is a string, not object)
包含描述长度的卡片信息(description是字符串,不是对象)
fizzy card show 579 | jq '.data | {number, title, desc_length: (.description | length)}'
fizzy card show 579 | jq '.data | {number, title, desc_length: (.description | length)}'
Cards with a specific status
特定状态的卡片
fizzy card list --all | jq '[.data[] | select(.status == "published")]'
fizzy card list --all | jq '[.data[] | select(.status == "published")]'
fizzy card list --indexed-by golden | jq '[.data[] | {number, title}]'
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}]'
fizzy card list | jq '[.data[] | select(.description | length > 0) | {number, title}]'
Cards with steps (must use card show, steps not in list)
包含步骤的卡片(必须使用card show,列表中不包含steps)
fizzy card show 579 | jq '.data.steps'
fizzy card show 579 | jq '.data.steps'
Extracting Nested Data
提取嵌套数据
Comment text only (body.plain_text for comments)
仅评论文本(评论使用.body.plain_text)
fizzy comment list --card 579 | jq '[.data[].body.plain_text]'
fizzy comment list --card 579 | jq '[.data[].body.plain_text]'
Card description (just .description for cards - it's a string)
卡片描述(卡片使用.description,是字符串)
fizzy card show 579 | jq '.data.description'
fizzy card show 579 | jq '.data.description'
Step completion status
步骤完成状态
fizzy card show 579 | jq '[.data.steps[] | {content, completed}]'
fizzy card show 579 | jq '[.data.steps[] | {content, completed}]'
Cards with steps count (requires card show for each)
包含步骤数量的卡片信息(需要对每个卡片使用card show)
fizzy card show 579 | jq '.data | {number, title, steps_count: (.steps | length)}'
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'
fizzy comment list --card 579 | jq '.data | length'
bash
fizzy identity show # Show your identity and accessible accounts
bash
fizzy identity show # 显示您的身份和可访问的账户
Quick text search across cards. Multiple words are treated as separate terms (AND).
bash
fizzy search QUERY [flags]
--board ID # Filter by board
--assignee ID # Filter by assignee user ID
--tag ID # Filter by tag ID
--indexed-by LANE # Filter: all, closed, not_now, golden
--sort ORDER # Sort: newest, oldest, or latest (default)
--page N # Page number
--all # Fetch all pages
Examples:
bash
fizzy search "bug" # Search for "bug"
fizzy search "login error" # Search for cards containing both "login" AND "error"
fizzy search "bug" --board BOARD_ID # Search within a specific board
fizzy search "bug" --indexed-by closed # Include closed cards
fizzy search "feature" --sort newest # Sort by newest first
在卡片中快速搜索文本。多个单词被视为独立的搜索词(逻辑与)。
bash
fizzy search QUERY [flags]
--board ID # 按看板过滤
--assignee ID # 按被分配人用户ID过滤
--tag ID # 按标签ID过滤
--indexed-by LANE # 过滤条件:all、closed、not_now、golden
--sort ORDER # 排序方式:newest、oldest或latest(默认)
--page N # 页码
--all # 获取所有页面
示例:
bash
fizzy search "bug" # 搜索包含"bug"的内容
fizzy search "login error" # 搜索同时包含"login"和"error"的卡片
fizzy search "bug" --board BOARD_ID # 在指定看板内搜索
fizzy search "bug" --indexed-by closed # 包含已关闭的卡片
fizzy search "feature" --sort newest # 按最新创建排序
bash
fizzy board list [--page N] [--all]
fizzy board show BOARD_ID
fizzy board create --name "Name" [--all_access true/false] [--auto_postpone_period N]
fizzy board update BOARD_ID [--name "Name"] [--all_access true/false] [--auto_postpone_period N]
fizzy board delete BOARD_ID
bash
fizzy board list [--page N] [--all]
fizzy board show BOARD_ID
fizzy board create --name "名称" [--all_access true/false] [--auto_postpone_period N]
fizzy board update BOARD_ID [--name "名称"] [--all_access true/false] [--auto_postpone_period N]
fizzy board delete BOARD_ID
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
.
在账户之间迁移看板(例如从个人账户到团队账户)。
bash
fizzy migrate board BOARD_ID --from SOURCE_SLUG --to TARGET_SLUG [flags]
--include-images # 迁移卡片页眉图片和内联附件
--include-comments # 迁移卡片评论
--include-steps # 迁移卡片步骤(待办事项)
--dry-run # 预览迁移,不实际修改
迁移内容:
- 同名看板
- 所有列(保留顺序和颜色)
- 所有卡片,包含标题、描述、时间戳和标签
- 卡片状态(已关闭、已标星、所在列)
- 可选:页眉图片、内联附件、评论和步骤
无法迁移的内容:
- 卡片创建者(将变为执行迁移的用户)
- 卡片编号(目标账户中使用新的连续编号)
- 评论作者(将变为执行迁移的用户)
- 用户分配(团队需手动重新分配)
要求: 您必须拥有源账户和目标账户的API访问权限。使用
验证。
Preview migration first
先预览迁移
fizzy migrate board BOARD_ID --from personal --to team-account --dry-run
fizzy migrate board BOARD_ID --from personal --to team-account --dry-run
fizzy migrate board BOARD_ID --from personal --to team-account
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
fizzy migrate board BOARD_ID --from personal --to team-account
--include-images --include-comments --include-steps
bash
fizzy card list [flags]
--board ID # Filter by board
--column ID # Filter by column ID or pseudo: not-yet, maybe, done
--assignee ID # Filter by assignee user ID
--tag ID # Filter by tag ID
--indexed-by LANE # Filter: all, closed, 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)
bash
fizzy card list [flags]
--board ID # 按看板过滤
--column ID # 按列ID或伪列过滤:not-yet、maybe、done
--assignee ID # 按被分配人用户ID过滤
--tag ID # 按标签ID过滤
--indexed-by LANE # 过滤条件:all、closed、not_now、stalled、postponing_soon、golden
--search "terms" # 按文本搜索(空格分隔多个搜索词)
--sort ORDER # 排序方式:newest、oldest或latest(默认)
--creator ID # 按创建者用户ID过滤
--closer ID # 按关闭卡片的用户ID过滤
--unassigned # 仅显示未分配的卡片
--created PERIOD # 按创建时间过滤:today、yesterday、thisweek、lastweek、thismonth、lastmonth
--closed PERIOD # 按关闭时间过滤:today、yesterday、thisweek、lastweek、thismonth、lastmonth
--page N # 页码
--all # 获取所有页面
fizzy card show CARD_NUMBER # 显示卡片详情(包含步骤)
bash
fizzy card create --board ID --title "Title" [flags]
--description "HTML" # Card description (HTML)
--description_file PATH # Read description from file
--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 "HTML"
--description_file PATH
--image SIGNED_ID
--created-at TIMESTAMP
fizzy card delete CARD_NUMBER
bash
fizzy card create --board ID --title "标题" [flags]
--description "HTML" # 卡片描述(HTML格式)
--description_file PATH # 从文件读取描述
--image SIGNED_ID # 页眉图片(使用上传返回的signed_id)
--tag-ids "id1,id2" # 逗号分隔的标签ID
--created-at TIMESTAMP # 自定义创建时间
fizzy card update CARD_NUMBER [flags]
--title "标题"
--description "HTML"
--description_file PATH
--image SIGNED_ID
--created-at TIMESTAMP
fizzy card delete CARD_NUMBER
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
field stays "published" for active cards. Use:
- to check if closed
- to find postponed cards
- to find closed cards
bash
fizzy card close CARD_NUMBER # 关闭卡片(设置closed: true)
fizzy card reopen CARD_NUMBER # 重新打开已关闭的卡片
fizzy card postpone CARD_NUMBER # 移动到“暂不处理”列
fizzy card untriage CARD_NUMBER # 从列中移除,回到待处理状态
注意: 活跃卡片的
字段始终为"published"。请使用:
- 判断卡片是否关闭
- 查找已推迟的卡片
- 查找已关闭的卡片
bash
fizzy card column CARD_NUMBER --column ID # Move to column (use column ID or: maybe, not-yet, 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 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 golden CARD_NUMBER # Mark as golden/starred
fizzy card ungolden CARD_NUMBER # Remove golden status
fizzy card image-remove CARD_NUMBER # Remove header image
bash
fizzy card column CARD_NUMBER --column ID # 移动到指定列(使用列ID或:maybe、not-yet、done)
fizzy card move CARD_NUMBER --to BOARD_ID # 将卡片移动到另一个看板
fizzy card assign CARD_NUMBER --user ID # 切换用户分配状态
fizzy card tag CARD_NUMBER --tag "名称" # 切换标签(不存在则创建)
fizzy card watch CARD_NUMBER # 订阅通知
fizzy card unwatch CARD_NUMBER # 取消订阅
fizzy card golden CARD_NUMBER # 标记为标星/重要
fizzy card ungolden CARD_NUMBER # 移除标星状态
fizzy card image-remove CARD_NUMBER # 移除页眉图片
bash
fizzy card attachments show CARD_NUMBER # List attachments
fizzy card attachments download CARD_NUMBER [INDEX] # Download (1-based index)
-o, --output FILENAME # Output filename (single file)
bash
fizzy card attachments show CARD_NUMBER # 列出附件
fizzy card attachments download CARD_NUMBER [INDEX] # 下载附件(索引从1开始)
-o, --output FILENAME # 输出文件名(单个文件)
Boards have pseudo columns by default:
,
,
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
bash
fizzy column list --board ID
fizzy column show COLUMN_ID --board ID
fizzy column create --board ID --name "名称" [--color HEX]
fizzy column update COLUMN_ID --board ID [--name "名称"] [--color HEX]
fizzy column delete COLUMN_ID --board ID
bash
fizzy comment list --card NUMBER [--page N] [--all]
fizzy comment show COMMENT_ID --card NUMBER
fizzy comment create --card NUMBER --body "HTML" [--body_file PATH] [--created-at TIMESTAMP]
fizzy comment update COMMENT_ID --card NUMBER [--body "HTML"] [--body_file PATH]
fizzy comment delete COMMENT_ID --card NUMBER
bash
fizzy comment list --card NUMBER [--page N] [--all]
fizzy comment show COMMENT_ID --card NUMBER
fizzy comment create --card NUMBER --body "HTML" [--body_file PATH] [--created-at TIMESTAMP]
fizzy comment update COMMENT_ID --card NUMBER [--body "HTML"] [--body_file PATH]
fizzy comment delete COMMENT_ID --card NUMBER
Steps (To-Do Items)
步骤(待办事项)
Steps are returned in
response. No separate list command.
bash
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
bash
fizzy step show STEP_ID --card NUMBER
fizzy step create --card NUMBER --content "文本" [--completed]
fizzy step update STEP_ID --card NUMBER [--content "文本"] [--completed] [--not_completed]
fizzy step delete STEP_ID --card NUMBER
Reactions can be added to cards directly or to comments on cards.
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
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
| Flag | Required | Description |
|------|----------|-------------|
| `--card` | Yes | Card number (always required) |
| `--comment` | No | Comment ID (omit for card reactions) |
| `--content` | Yes (create) | Emoji or text, max 16 characters |
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
| 标志 | 是否必填 | 描述 |
|------|----------|-------------|
| `--card` | 是 | 卡片编号(始终必填) |
| `--comment` | 否 | 评论ID(卡片互动时省略) |
| `--content` | 是(创建时) | 表情符号或文本,最多16个字符 |
Tags are created automatically when using
. List shows all existing tags.
bash
fizzy tag list [--page N] [--all]
使用
命令时会自动创建标签。列表命令显示所有已存在的标签。
bash
fizzy tag list [--page N] [--all]
bash
fizzy user list [--page N] [--all]
fizzy user show USER_ID
bash
fizzy user list [--page N] [--all]
fizzy user show USER_ID
bash
fizzy notification list [--page N] [--all]
fizzy notification read NOTIFICATION_ID
fizzy notification read-all
fizzy notification unread NOTIFICATION_ID
bash
fizzy notification list [--page N] [--all]
fizzy notification read NOTIFICATION_ID
fizzy notification read-all
fizzy notification unread NOTIFICATION_ID
bash
fizzy upload file PATH
bash
fizzy upload file PATH
Returns: { "signed_id": "...", "attachable_sgid": "..." }
返回:{ "signed_id": "...", "attachable_sgid": "..." }
| ID | Use For |
|---|---|
| `signed_id` | Card header/background images (`--image` flag) |
| `attachable_sgid` | Inline images in rich text (descriptions, comments) |
---
| ID | 用途 |
|---|---|
| `signed_id` | 卡片页眉/背景图片(`--image`标志使用) |
| `attachable_sgid` | 富文本中的内联图片(描述、评论) |
---
Create Card with Steps
创建包含步骤的卡片
CARD=$(fizzy card create --board BOARD_ID --title "New Feature"
--description "<p>Feature description</p>" | jq -r '.data.number')
CARD=$(fizzy card create --board BOARD_ID --title "新功能"
--description "<p>功能描述</p>" | jq -r '.data.number')
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"
fizzy step create --card $CARD --content "设计功能"
fizzy step create --card $CARD --content "实现后端"
fizzy step create --card $CARD --content "编写测试"
Create Card with Inline Image
创建包含内联图片的卡片
SGID=$(fizzy upload file screenshot.png | jq -r '.data.attachable_sgid')
SGID=$(fizzy upload file screenshot.png | jq -r '.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
cat > desc.html << EOF
<p>请查看下方截图:</p>
<action-text-attachment sgid="$SGID"></action-text-attachment>
EOF
fizzy card create --board BOARD_ID --title "Bug Report" --description_file desc.html
fizzy card create --board BOARD_ID --title "漏洞报告" --description_file desc.html
Create Card with Background Image (only when explicitly requested)
创建包含背景图片的卡片(仅在明确要求时使用)
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
MIME=$(file --mime-type -b /path/to/image.png)
if [[ ! "$MIME" =~ ^image/ ]]; then
echo "错误:不是有效的图片(检测到:$MIME)"
exit 1
fi
Upload and get signed_id
上传并获取signed_id
SIGNED_ID=$(fizzy upload file /path/to/header.png | jq -r '.data.signed_id')
SIGNED_ID=$(fizzy upload file /path/to/header.png | jq -r '.data.signed_id')
Create card with background
创建带背景的卡片
fizzy card create --board BOARD_ID --title "Card" --image "$SIGNED_ID"
fizzy card create --board BOARD_ID --title "卡片" --image "$SIGNED_ID"
Move Card Through Workflow
卡片工作流操作
fizzy card column 579 --column maybe
fizzy card column 579 --column maybe
fizzy card assign 579 --user USER_ID
fizzy card assign 579 --user USER_ID
Mark as golden (important)
标记为标星(重要)
When done, close it
完成后关闭卡片
Move Card to Different Board
将卡片移动到其他看板
Move card to another board
将卡片移动到另一个看板
fizzy card move 579 --to TARGET_BOARD_ID
fizzy card move 579 --to TARGET_BOARD_ID
Search and Filter Cards
搜索和过滤卡片
fizzy search "bug" | jq '[.data[] | {number, title}]'
fizzy search "bug" | jq '[.data[] | {number, title}]'
Search with filters
带过滤条件的搜索
fizzy search "login" --board BOARD_ID --sort newest
fizzy search "login" --board BOARD_ID --sort newest
Find recently created cards
查找最近创建的卡片
fizzy card list --created today --sort newest
fizzy card list --created today --sort newest
Find cards closed this week
查找本周关闭的卡片
fizzy card list --indexed-by closed --closed thisweek
fizzy card list --indexed-by closed --closed thisweek
Find unassigned cards
查找未分配的卡片
fizzy card list --unassigned --board BOARD_ID
fizzy card list --unassigned --board BOARD_ID
Add reaction directly to a card
直接对卡片添加互动
fizzy reaction create --card 579 --content "👍"
fizzy reaction create --card 579 --content "👍"
List reactions on a card
列出卡片的所有互动
fizzy reaction list --card 579 | jq '[.data[] | {id, content, reacter: .reacter.name}]'
fizzy reaction list --card 579 | jq '[.data[] | {id, content, reacter: .reacter.name}]'
Add Comment with Reaction
添加评论并对评论添加互动
COMMENT=$(fizzy comment create --card 579 --body "<p>Looks good!</p>" | jq -r '.data.id')
COMMENT=$(fizzy comment create --card 579 --body "<p>看起来不错!</p>" | jq -r '.data.id')
Add reaction to the comment
对评论添加互动
fizzy reaction create --card 579 --comment $COMMENT --content "👍"
fizzy reaction create --card 579 --comment $COMMENT --content "👍"
Rich Text Formatting
富文本格式
Card descriptions and comments support HTML. For multiple paragraphs with spacing:
html
<p>First paragraph.</p>
<p><br></p>
<p>Second paragraph with spacing above.</p>
Note: Each
can only be used once. Upload the file again for multiple uses.
卡片描述和评论支持HTML。如需带间距的多段落:
html
<p>第一段。</p>
<p><br></p>
<p>第二段,上方带有间距。</p>
注意: 每个
只能使用一次。多次使用需重新上传文件。
- Card images: Use inline (via in description) by default. Only use background/header ( with ) when user explicitly says "background" or "header".
- Comment images: Always inline. Comments do not support background images.
- 卡片图片: 默认使用内联图片(在描述中使用)。仅当用户明确提到“背景”或“页眉”时,才使用背景/页眉图片(配合标志)。
- 评论图片: 始终使用内联图片。评论不支持背景图片。
- Determine the action - What does the user want?
- Check for account context - Use if needed
- Run the fizzy command using Bash
- Parse JSON output with jq to reduce tokens
- Report outcome clearly, including card numbers/entity IDs for reference
- 确定操作 - 用户想要执行什么操作?
- 检查账户上下文 - 必要时使用
- 使用Bash运行fizzy命令
- 使用jq解析JSON输出以减少返回内容
- 清晰报告结果,包含卡片编号/实体ID作为参考