核心用法
Workflowy CLI 是一个非官方命令行工具,通过 Workflowy 官方 API 实现对个人大纲的完全操控。用户需先在 https://workflowy.com/api-key/ 获取密钥,保存至 ~/.workflowy/api.key 并设置 600 权限。
读取能力:支持获取根节点、指定节点(UUID/短 ID/URL)、层级展开、全文搜索(支持正则与限定子树范围)。
写入能力:涵盖创建节点(支持 inbox/home 快捷目标)、重命名、完成/取消完成、移动、删除(级联删除子节点)。
批量操作:搜索替换(支持 dry-run 与交互模式、正则捕获组)、内容转换(按换行拆分、去空白)。
统计报告:节点数量分布、子节点最多的条目、最旧修改内容、镜像节点分析。
三种数据访问模式:get(实时中等速度)、export(缓存约 1 分钟,适合全树)、backup(本地备份,最快但数据非最新)。
显著优点
- 功能覆盖全面,几乎实现 Workflowy Web 端的所有核心操作
- 支持短 ID 与完整 URL 直接解析,降低手动查找成本
- 批量替换与转换适合大规模内容整理
- 离线备份模式保障数据可控性
- 输出按优先级排序,符合 Workflowy 原生体验
潜在缺点与局限性
- 非官方工具,依赖社区维护,API 变更时可能失效
- 删除操作不可逆且级联,误删风险高
- 批量替换无事务回滚,dry-run 虽可预览但交互模式仍需人工确认
backup方法数据陈旧,镜像分析等功能强制依赖此模式- 需手动管理 API 密钥文件权限,配置门槛对新手不友好
适合人群
- 重度 Workflowy 用户,需自动化整理或与其他工具链集成
- 习惯命令行效率、熟悉正则表达式的开发者/技术写作者
- 需要批量重构大纲结构的内容管理者
常规风险
- API 密钥以明文存储于本地文件,若权限配置不当存在泄露风险
- 第三方工具无 SLA 保障,关键业务依赖需谨慎评估
- 误操作(如批量替换正则错误、误删节点)可能导致数据丢失