核心用法
workflowy CLI 是一款非官方的命令行工具,封装了 Workflowy API,让用户无需打开网页即可完成大纲的读写操作。安装后配置 API key 即可使用,支持通过 UUID、短链接或特殊别名(inbox/home)定位节点。
读取能力:获取指定层级的大纲树、按关键词或正则表达式全文搜索、查看节点统计报告(内容分布、子节点数量、最旧修改时间等)。
写入能力:创建节点、更新内容、标记完成/未完成、移动节点、删除(级联删除子节点)。
批量操作:查找替换(支持正则捕获组)、节点内容转换(按换行拆分子节点、去除空白字符)。
数据策略:提供三种访问模式——实时 API(get)、缓存导出(export,约1分钟延迟)、Dropbox 备份(backup,离线可用),用户可根据速度与新鲜度需求灵活选择。
显著优点
- 纯文本工作流:适合习惯终端的用户,可与 fzf、jq、shell 脚本无缝集成。
- 批量处理能力:正则替换、内容转换等功能弥补了网页端批量编辑的不足。
- 离线支持:通过 Dropbox 备份实现无网络环境下的数据读取。
- 灵活的节点引用:支持短 ID、完整 URL、inbox/home 别名,降低操作门槛。
潜在局限
- 非官方工具:由社区开发者维护,存在 API 变更导致失效的风险。
- 删除不可逆:级联删除无确认提示,误操作后果严重。
- 学习成本:需要熟悉命令行参数与 Workflowy 的数据模型(UUID、镜像节点等概念)。
- 实时性权衡:批量操作依赖缓存数据,可能操作到过期内容。
适合人群
- 每日重度使用 Workflowy 且追求效率的进阶用户
- 需要将大纲数据与其他 CLI 工具(如任务管理器、笔记系统)集成的开发者
- 希望自动化重复编辑任务(如批量重命名、整理归档)的自动化爱好者
常规风险
- 数据丢失:delete 命令会连带删除所有子节点且无回收站机制,建议操作前备份。
- 批量替换风险:replace 命令默认直接执行,务必先用 --dry-run 验证,配合 --interactive 二次确认。
- API 密钥安全:key 文件存储于本地 ~/.workflowy/,需确保权限设置为 600,避免多用户环境泄露。