核心用法
Fizzy CLI 是一个功能完整的项目管理命令行工具,用于管理 Fizzy 平台上的看板(boards)、卡片(cards)、步骤(steps)、评论(comments)和反馈(reactions)。用户通过 Homebrew 安装后,需配置 API Token 和账户信息(支持环境变量或配置文件),即可在终端执行完整的项目管理工作流。
主要功能模块
看板管理:创建、更新、删除看板,设置访问权限和自动延后周期。卡片操作:支持创建、更新、关闭/重新打开、延后、标记为重要(golden)、分配负责人、添加标签、移动至不同列等完整生命周期管理。步骤管理:为卡片添加待办事项,支持完成状态切换。评论系统:创建富文本评论(支持内联图片),添加表情反馈。文件上传:支持上传图片作为卡片背景或内嵌到描述/评论中。
数据查询与过滤
提供强大的列表过滤能力:按看板、列(支持伪列如 not-yet/maybe/done)、负责人、标签筛选;支持按索引 lane(all/closed/not_now/stalled/postponing_soon/golden)快速定位卡片。所有列表命令支持分页(--page)和全量获取(--all)。
JSON 处理与集成
所有命令返回结构化 JSON,可通过 jq 进行高效的数据提取、过滤和转换。文档提供了丰富的 jq 模式示例,包括字段精简、条件过滤、嵌套数据提取等。支持 --pretty 美化输出和 --verbose 调试请求。
显著优点
- 完整的 CLI 覆盖:几乎所有 Web 端功能都有对应的命令行接口
- 一致的响应格式:统一的 success/data/meta/error 结构,易于程序化解析
- 灵活的身份验证:支持环境变量(适合 CI/CD)和配置文件(适合个人使用)
- 富文本支持:HTML 描述和评论,支持通过
attachable_sgid嵌入图片 - 清晰的资源标识:区分内部 ID 和数字编号,减少操作混淆
潜在缺点与局限性
- 双标识符系统:卡片同时使用
id(内部)和number(CLI 命令),易混淆;其他资源仅用id - 列表与详情差异:
steps仅在card show中返回,card list不包含,需额外查询 - 无原生限制参数:列表命令无
--limit,需通过jq切片(如.data[:5])实现 - HTML 格式要求:描述和评论需手动构造 HTML,无 Markdown 等简化格式
- 单次附件复用限制:同一
attachable_sgid只能使用一次,多次使用需重新上传
适合人群
- 偏好终端工作流的开发者和项目经理
- 需要自动化 Fizzy 工作流、批量操作卡片的 DevOps/运维人员
- 构建 CI/CD 集成、自动化报告或数据迁移脚本的技术团队
- 自托管 Fizzy 实例的管理员
常规风险
- Token 安全:Personal Access Token 需妥善保管,避免硬编码或泄露到版本控制
- 数据误操作:
delete、close等命令不可逆,建议在批量操作前验证过滤条件 - API 限流:高频自动化脚本可能触发限流,需实现退避重试机制
- 字段路径变更:依赖特定 jq 路径的脚本可能因 API 响应结构调整而失效