fizzy

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Fizzy CLI Skill

Fizzy CLI 技能

Manage Fizzy boards, cards, steps, comments, and reactions.

管理Fizzy看板、卡片、步骤、评论和互动。

Quick Reference

快速参考

Resource	List	Show	Create	Update	Delete	Other
board	`board list`	`board show ID`	`board create`	`board update ID`	`board delete ID`	`migrate board ID`
card	`card list`	`card show NUMBER`	`card create`	`card update NUMBER`	`card delete NUMBER`	`card move NUMBER`
search	`search QUERY`	-	-	-	-	-
column	`column list --board ID`	`column show ID --board ID`	`column create`	`column update ID`	`column delete ID`	-
comment	`comment list --card NUMBER`	`comment show ID --card NUMBER`	`comment create`	`comment update ID`	`comment delete ID`	-
step	-	`step show ID --card NUMBER`	`step create`	`step update ID`	`step delete ID`	-
reaction	`reaction list`	-	`reaction create`	-	`reaction delete ID`	-
tag	`tag list`	-	-	-	-	-
user	`user list`	`user show ID`	-	-	-	-
notification	`notification list`	-	-	-	-	-

资源	列表	详情	创建	更新	删除	其他
看板	`board list`	`board show ID`	`board create`	`board update ID`	`board delete ID`	`migrate board ID`
卡片	`card list`	`card show NUMBER`	`card create`	`card update NUMBER`	`card delete NUMBER`	`card move NUMBER`
搜索	`search QUERY`	-	-	-	-	-
列	`column list --board ID`	`column show ID --board ID`	`column create`	`column update ID`	`column delete ID`	-
评论	`comment list --card NUMBER`	`comment show ID --card NUMBER`	`comment create`	`comment update ID`	`comment delete ID`	-
步骤	-	`step show ID --card NUMBER`	`step create`	`step update ID`	`step delete ID`	-
互动	`reaction list`	-	`reaction create`	-	`reaction delete ID`	-
标签	`tag list`	-	-	-	-	-
用户	`user list`	`user show ID`	-	-	-	-
通知	`notification list`	-	-	-	-	-

ID Formats

ID 格式

IMPORTANT: Cards use TWO identifiers:

Field	Format	Use For
`id`	`03fe4rug9kt1mpgyy51lq8i5i`	Internal ID (in JSON responses)
`number`	`579`	CLI 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.

重要提示： 卡片使用两种标识符：

字段	格式	用途
`id`	`03fe4rug9kt1mpgyy51lq8i5i`	内部ID（仅在JSON响应中使用）
`number`	`579`	CLI命令使用（如 `card show` 、 `card update` 等）

所有卡片CLI命令均使用卡片NUMBER，而非ID。

其他资源（看板、列、评论、步骤、互动、用户）使用其

id

字段。

Response Structure

响应结构

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
`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

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

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.

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
`board list`	"5个看板"
`board show ID`	"看板：工程"
`card list`	"42张卡片（第1页）" 或 "42张卡片（全部）"
`card show 123`	"卡片#123：修复登录漏洞"
`search "bug"`	"7条关于"bug"的结果"
`notification list`	"8条通知（3条未读）"

带分页的列表响应：

json

{
  "success": true,
  "data": [ ... ],
  "summary": "10张卡片（第1页）",
  "pagination": {
    "has_next": true,
    "next_url": "https://..."
  },
  "meta": { ... }
}

Breadcrumbs（上下文后续操作）：

响应包含

breadcrumbs

数组，提示您接下来可以执行的操作。每个breadcrumb包含：

```
action
```
: 简短操作名称（如"comment"、"close"、"assign"）
```
cmd
```
: 可直接运行的命令，已插入实际值
```
description
```
: 人类可读的描述

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等值已预先填充；

<column_id>

等占位符需要替换。

错误响应：

json

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "未找到",
    "status": 404
  },
  "meta": { ... }
}

创建/更新响应包含位置信息：

json

{
  "success": true,
  "data": { ... },
  "location": "/6102600/cards/579.json",
  "meta": { ... }
}

Resource Schemas

资源架构

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

所有资源的完整字段参考。在jq查询中请使用这些精确的字段路径。

Card Schema

卡片架构

IMPORTANT:

card list

and

card show

return different fields.

steps

only in

card show

Field	Type	Description
`number`	integer	Use this for CLI commands
`id`	string	Internal ID (in responses only)
`title`	string	Card title
`description`	string	Plain text content (NOT an object)
`description_html`	string	HTML version with attachments
`status`	string	Usually "published" for active cards
`closed`	boolean	true = card is closed
`golden`	boolean	true = starred/important
`image_url`	string/null	Header/background image URL
`has_more_assignees`	boolean	More assignees than shown
`created_at`	timestamp	ISO 8601
`last_active_at`	timestamp	ISO 8601
`url`	string	Web URL
`comments_url`	string	Comments endpoint URL
`board`	object	Nested Board (see below)
`creator`	object	Nested User (see below)
`assignees`	array	Array of User objects
`tags`	array	Array of Tag objects
`steps`	array	Only in `card show` , not in list

重要提示：

card list

和

card show

返回的字段不同。

steps

仅在

card show

中返回。

字段	类型	描述
`number`	整数	CLI命令使用此字段
`id`	字符串	内部ID（仅在响应中使用）
`title`	字符串	卡片标题
`description`	字符串	纯文本内容（不是对象）
`description_html`	字符串	带附件的HTML版本
`status`	字符串	活跃卡片通常为"published"
`closed`	布尔值	true = 卡片已关闭
`golden`	布尔值	true = 已标星/重要
`image_url`	字符串/null	页眉/背景图片URL
`has_more_assignees`	布尔值	存在未显示的更多被分配人
`created_at`	时间戳	ISO 8601格式
`last_active_at`	时间戳	ISO 8601格式
`url`	字符串	网页URL
`comments_url`	字符串	评论端点URL
`board`	对象	嵌套的看板对象（见下文）
`creator`	对象	嵌套的用户对象（见下文）
`assignees`	数组	用户对象数组
`tags`	数组	标签对象数组
`steps`	数组	仅在 `card show` 中返回，列表中不包含

Board Schema

看板架构

Field	Type	Description
`id`	string	Board ID (use for CLI commands)
`name`	string	Board name
`all_access`	boolean	All users have access
`created_at`	timestamp	ISO 8601
`url`	string	Web URL
`creator`	object	Nested User

字段	类型	描述
`id`	字符串	看板ID（CLI命令使用此字段）
`name`	字符串	看板名称
`all_access`	布尔值	所有用户都有访问权限
`created_at`	时间戳	ISO 8601格式
`url`	字符串	网页URL
`creator`	对象	嵌套的用户对象

User Schema

用户架构

Field	Type	Description
`id`	string	User ID (use for CLI commands)
`name`	string	Display name
`email_address`	string	Email
`role`	string	"owner", "admin", or "member"
`active`	boolean	Account is active
`created_at`	timestamp	ISO 8601
`url`	string	Web URL

字段	类型	描述
`id`	字符串	用户ID（CLI命令使用此字段）
`name`	字符串	显示名称
`email_address`	字符串	邮箱
`role`	字符串	"owner"、"admin"或"member"
`active`	布尔值	账户处于活跃状态
`created_at`	时间戳	ISO 8601格式
`url`	字符串	网页URL

Comment Schema

评论架构

Field	Type	Description
`id`	string	Comment ID (use for CLI commands)
`body`	object	Nested object with html and plain_text
`body.html`	string	HTML content
`body.plain_text`	string	Plain text content
`created_at`	timestamp	ISO 8601
`updated_at`	timestamp	ISO 8601
`url`	string	Web URL
`reactions_url`	string	Reactions endpoint URL
`creator`	object	Nested User
`card`	object	Nested {id, url}

字段	类型	描述
`id`	字符串	评论ID（CLI命令使用此字段）
`body`	对象	包含html和plain_text的嵌套对象
`body.html`	字符串	HTML内容
`body.plain_text`	字符串	纯文本内容
`created_at`	时间戳	ISO 8601格式
`updated_at`	时间戳	ISO 8601格式
`url`	字符串	网页URL
`reactions_url`	字符串	互动端点URL
`creator`	对象	嵌套的用户对象
`card`	对象	嵌套的{id, url}对象

Step Schema

步骤架构

Field	Type	Description
`id`	string	Step ID (use for CLI commands)
`content`	string	Step text
`completed`	boolean	Completion status

字段	类型	描述
`id`	字符串	步骤ID（CLI命令使用此字段）
`content`	字符串	步骤文本
`completed`	布尔值	完成状态

Column Schema

列架构

Field	Type	Description
`id`	string	Column ID or pseudo ID ("not-now", "maybe", "done")
`name`	string	Display name
`kind`	string	"not_now", "triage", "closed", or custom
`pseudo`	boolean	true = built-in column

字段	类型	描述
`id`	字符串	列ID或伪ID（"not-now"、"maybe"、"done"）
`name`	字符串	显示名称
`kind`	字符串	"not_now"、"triage"、"closed"或自定义
`pseudo`	布尔值	true = 内置列

Tag Schema

标签架构

Field	Type	Description
`id`	string	Tag ID
`title`	string	Tag name
`created_at`	timestamp	ISO 8601
`url`	string	Web URL

字段	类型	描述
`id`	字符串	标签ID
`title`	字符串	标签名称
`created_at`	时间戳	ISO 8601格式
`url`	字符串	网页URL

Reaction Schema

互动架构

Field	Type	Description
`id`	string	Reaction ID (use for CLI commands)
`content`	string	Emoji
`url`	string	Web URL
`reacter`	object	Nested User

字段	类型	描述
`id`	字符串	互动ID（CLI命令使用此字段）
`content`	字符串	表情符号
`url`	字符串	网页URL
`reacter`	对象	嵌套的用户对象

Identity Schema (from

identity show

)

身份架构（来自

identity show

）

Field	Type	Description
`accounts`	array	Array of Account objects
`accounts[].id`	string	Account ID
`accounts[].name`	string	Account name
`accounts[].slug`	string	Account slug (use with --account)
`accounts[].user`	object	Your User in this account

字段	类型	描述
`accounts`	数组	账户对象数组
`accounts[].id`	字符串	账户ID
`accounts[].name`	字符串	账户名称
`accounts[].slug`	字符串	账户别名（与--account参数一起使用）
`accounts[].user`	对象	您在此账户中的用户信息

Key Schema Differences

关键架构差异

Resource	Text Field	HTML Field
Card	`.description` (string)	`.description_html` (string)
Comment	`.body.plain_text` (nested)	`.body.html` (nested)

资源	文本字段	HTML字段
卡片	`.description` （字符串）	`.description_html` （字符串）
评论	`.body.plain_text` （嵌套）	`.body.html` （嵌套）

Global Flags

全局标志

All commands support:

Flag	Description
`--account SLUG`	Account slug (for multi-account users)
`--pretty`	Pretty-print JSON output
`--verbose`	Show request/response details

所有命令均支持：

标志	描述
`--account SLUG`	账户别名（针对多账户用户）
`--pretty`	格式化输出JSON
`--verbose`	显示请求/响应详情

Pagination

分页

List commands use

--page

for pagination. There is NO

--limit

flag.

bash

undefined

列表命令使用

--page

进行分页。没有

--limit

标志。

bash

undefined

Get first page (default)

获取第一页（默认）

fizzy card list --page 1

Get specific number of results using jq

使用jq获取指定数量的结果

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`

---

Common jq Patterns

常用jq模式

Reducing Output

精简输出

bash

undefined

bash

undefined

Card summary (most useful)

卡片摘要（最实用）

fizzy card list | jq '[.data[] | {number, title, status, board: .board.name}]'

First N items

前N项

fizzy card list | jq '.data[:5]'

Just IDs

仅获取ID

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)

包含描述长度的卡片信息（description是字符串，不是对象）

fizzy card show 579 | jq '.data | {number, title, desc_length: (.description | length)}'

undefined

fizzy card show 579 | jq '.data | {number, title, desc_length: (.description | length)}'

undefined

Filtering

过滤

bash

undefined

bash

undefined

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)

包含步骤的卡片（必须使用card show，列表中不包含steps）

fizzy card show 579 | jq '.data.steps'

undefined

fizzy card show 579 | jq '.data.steps'

undefined

Extracting Nested Data

提取嵌套数据

bash

undefined

bash

undefined

Comment text only (body.plain_text for comments)

仅评论文本（评论使用.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'

Step completion status

步骤完成状态

fizzy card show 579 | jq '[.data.steps[] | {content, completed}]'

undefined

fizzy card show 579 | jq '[.data.steps[] | {content, completed}]'

undefined

Activity Analysis

活动分析

bash

undefined

bash

undefined

Cards with steps count (requires card show for each)

包含步骤数量的卡片信息（需要对每个卡片使用card show）

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'

---

Command Reference

命令参考

Identity

身份

bash

fizzy identity show                    # Show your identity and accessible accounts

bash

fizzy identity show                    # 显示您的身份和可访问的账户

Search

搜索

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   # 按最新创建排序

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 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

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

undefined

在账户之间迁移看板（例如从个人账户到团队账户）。

bash

fizzy migrate board BOARD_ID --from SOURCE_SLUG --to TARGET_SLUG [flags]
  --include-images                       # 迁移卡片页眉图片和内联附件
  --include-comments                     # 迁移卡片评论
  --include-steps                        # 迁移卡片步骤（待办事项）
  --dry-run                              # 预览迁移，不实际修改

迁移内容：

同名看板
所有列（保留顺序和颜色）
所有卡片，包含标题、描述、时间戳和标签
卡片状态（已关闭、已标星、所在列）
可选：页眉图片、内联附件、评论和步骤

无法迁移的内容：

卡片创建者（将变为执行迁移的用户）
卡片编号（目标账户中使用新的连续编号）
评论作者（将变为执行迁移的用户）
用户分配（团队需手动重新分配）

要求： 您必须拥有源账户和目标账户的API访问权限。使用

fizzy identity show

验证。

bash

undefined

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

undefined

fizzy migrate board BOARD_ID --from personal --to team-account
--include-images --include-comments --include-steps

undefined

Cards

卡片

Listing & Viewing

列表与查看

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            # 显示卡片详情（包含步骤）

Creating & Updating

创建与更新

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

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

bash

fizzy card close CARD_NUMBER           # 关闭卡片（设置closed: true）
fizzy card reopen CARD_NUMBER          # 重新打开已关闭的卡片
fizzy card postpone CARD_NUMBER        # 移动到“暂不处理”列
fizzy card untriage CARD_NUMBER        # 从列中移除，回到待处理状态

注意： 活跃卡片的

status

字段始终为"published"。请使用：

```
closed: true/false
```
判断卡片是否关闭
```
--indexed-by not_now
```
查找已推迟的卡片
```
--indexed-by closed
```
查找已关闭的卡片

Actions

操作

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           # 移除页眉图片

Attachments

附件

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                                    # 输出文件名（单个文件）

Columns

列

Boards have pseudo columns by default:

not-yet

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

看板默认包含伪列：

not-yet

、

maybe

、

done

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

Comments

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

card show

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

步骤仅在

card show

响应中返回，没有单独的列表命令。

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

互动

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

bash

undefined

互动可以直接添加到卡片，或添加到卡片的评论中。

bash

undefined

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


| 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个字符 |

Users

用户

bash

fizzy user list [--page N] [--all]
fizzy user show USER_ID

bash

fizzy user list [--page N] [--all]
fizzy user show USER_ID

Notifications

通知

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

File Uploads

文件上传

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` | 富文本中的内联图片（描述、评论） |

---

Example Workflows

示例工作流

Create Card with Steps

创建包含步骤的卡片

bash

undefined

bash

undefined

Create the card

创建卡片

CARD=$(fizzy card create --board BOARD_ID --title "New Feature"
--description "Feature description" | jq -r '.data.number')

CARD=$(fizzy card create --board BOARD_ID --title "新功能"
--description "功能描述" | jq -r '.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"

undefined

fizzy step create --card $CARD --content "设计功能" fizzy step create --card $CARD --content "实现后端" fizzy step create --card $CARD --content "编写测试"

undefined

Create Card with Inline Image

创建包含内联图片的卡片

bash

undefined

bash

undefined

Upload image

上传图片

SGID=$(fizzy upload file screenshot.png | jq -r '.data.attachable_sgid')

Create description file with embedded image

创建包含嵌入图片的描述文件

cat > desc.html << EOF

See the screenshot below: <action-text-attachment sgid="$SGID"></action-text-attachment> EOF

cat > desc.html << EOF

请查看下方截图： <action-text-attachment sgid="$SGID"></action-text-attachment> EOF

Create card

创建卡片

fizzy card create --board BOARD_ID --title "Bug Report" --description_file desc.html

undefined

fizzy card create --board BOARD_ID --title "漏洞报告" --description_file desc.html

undefined

Create Card with Background Image (only when explicitly requested)

创建包含背景图片的卡片（仅在明确要求时使用）

bash

undefined

bash

undefined

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')

Create card with background

创建带背景的卡片

fizzy card create --board BOARD_ID --title "Card" --image "$SIGNED_ID"

undefined

fizzy card create --board BOARD_ID --title "卡片" --image "$SIGNED_ID"

undefined

Move Card Through Workflow

卡片工作流操作

bash

undefined

bash

undefined

Move to a column

移动到指定列

fizzy card column 579 --column maybe

Assign to user

分配给用户

fizzy card assign 579 --user USER_ID

Mark as golden (important)

标记为标星（重要）

fizzy card golden 579

When done, close it

完成后关闭卡片

fizzy card close 579

undefined

fizzy card close 579

undefined

Move Card to Different Board

将卡片移动到其他看板

bash

undefined

bash

undefined

Move card to another board

将卡片移动到另一个看板

fizzy card move 579 --to TARGET_BOARD_ID

undefined

fizzy card move 579 --to TARGET_BOARD_ID

undefined

Search and Filter Cards

搜索和过滤卡片

bash

undefined

bash

undefined

Quick search

快速搜索

fizzy search "bug" | jq '[.data[] | {number, title}]'

Search with filters

带过滤条件的搜索

fizzy 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

undefined

fizzy card list --unassigned --board BOARD_ID

undefined

React to a Card

对卡片添加互动

bash

undefined

bash

undefined

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}]'

undefined

fizzy reaction list --card 579 | jq '[.data[] | {id, content, reacter: .reacter.name}]'

undefined

Add Comment with Reaction

添加评论并对评论添加互动

bash

undefined

bash

undefined

Add comment

添加评论

COMMENT=$(fizzy comment create --card 579 --body "Looks good!" | jq -r '.data.id')

COMMENT=$(fizzy comment create --card 579 --body "看起来不错！" | 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

attachable_sgid

can only be used once. Upload the file again for multiple uses.

卡片描述和评论支持HTML。如需带间距的多段落：

html

<p>第一段。</p>
<p><br></p>
<p>第二段，上方带有间距。</p>

注意： 每个

attachable_sgid

只能使用一次。多次使用需重新上传文件。

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.

卡片图片： 默认使用内联图片（在描述中使用
```
attachable_sgid
```
）。仅当用户明确提到“背景”或“页眉”时，才使用背景/页眉图片（
```
signed_id
```
配合
```
--image
```
标志）。
评论图片： 始终使用内联图片。评论不支持背景图片。

Workflow Summary

工作流总结

Determine the action - What does the user want?
Check for account context - Use
```
--account=SLUG
```
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

确定操作 - 用户想要执行什么操作？
检查账户上下文 - 必要时使用
```
--account=SLUG
```
使用Bash运行fizzy命令
使用jq解析JSON输出以减少返回内容
清晰报告结果，包含卡片编号/实体ID作为参考

fizzy

Original

Translation

Fizzy CLI Skill

Fizzy CLI 技能

Quick Reference

快速参考

ID Formats

ID 格式

Response Structure

响应结构

Resource Schemas

资源架构

Card Schema

卡片架构

Board Schema

看板架构

User Schema

用户架构

Comment Schema

评论架构

Step Schema

步骤架构

Column Schema

列架构

Tag Schema

标签架构

Reaction Schema

互动架构

Identity Schema (from identity show)

身份架构（来自identity show）

Key Schema Differences

关键架构差异

Global Flags

全局标志

Pagination

分页

Get first page (default)

获取第一页（默认）

Get specific number of results using jq

使用jq获取指定数量的结果

Fetch ALL pages at once

一次性获取所有页面

Common jq Patterns

常用jq模式

Reducing Output

精简输出

Card summary (most useful)

卡片摘要（最实用）

First N items

前N项

Just IDs

仅获取ID

Specific fields from single item

单个条目的指定字段

Card with description length (description is a string, not object)

包含描述长度的卡片信息（description是字符串，不是对象）

Filtering

过滤

Cards with a specific status

特定状态的卡片

Golden cards only

仅标星卡片

Cards with non-empty descriptions

包含非空描述的卡片

Cards with steps (must use card show, steps not in list)

包含步骤的卡片（必须使用card show，列表中不包含steps）

Extracting Nested Data

提取嵌套数据

Comment text only (body.plain_text for comments)

仅评论文本（评论使用.body.plain_text）

Card description (just .description for cards - it's a string)

卡片描述（卡片使用.description，是字符串）

Step completion status

步骤完成状态

Activity Analysis

活动分析

Cards with steps count (requires card show for each)

包含步骤数量的卡片信息（需要对每个卡片使用card show）

Comments count for a card

Identity Schema (from
`identity show`
)

身份架构（来自
`identity show`
）