核心用法
Workflowy CLI 提供了一套完整的命令行接口,用于与 Workflowy API 进行交互。主要功能覆盖读取(get、list、search)、写入(create、update、complete、move、delete)以及批量操作(replace、transform)三大场景。用户可通过 UUID、短链接或特殊别名(inbox、home)定位节点,支持正则搜索、全文检索及子树限定查询。
数据访问提供三种模式:get(实时但较慢)、export(约1分钟缓存,适合全树操作)、backup(基于 Dropbox 备份,最快但数据滞后),用户可根据时效性需求灵活切换。统计功能包括节点计数、子节点分布、陈旧内容及镜像节点分析,辅助大纲健康度管理。
显著优点
- 离线友好:支持
--method=backup模式,无需实时联网即可执行大批量操作 - 批量高效:内置
replace与transform命令,支持正则捕获组与交互式确认,适合大规模内容迁移 - 定位灵活:同时支持完整 URL、短 ID 及语义别名,降低记忆成本
潜在缺点与局限性
- 非官方工具:由社区开发者维护,非 Workflowy 官方出品,存在 API 变更导致功能失效的风险
- 数据安全风险:
delete操作级联删除子节点且无回收站机制,误操作后果不可逆 - 认证方式简陋:API Key 以明文存储于本地文件,依赖文件权限(
chmod 600)保护,无密钥轮转或短期令牌机制 - 功能边界:不支持 Workflowy 的富文本格式、镜像节点实时同步等高级特性
适合人群
- 需要自动化处理上千条大纲条目的重度 Workflowy 用户
- 习惯终端工作流、偏好脚本化管理的开发者与效率极客
- 希望定期归档、清理陈旧内容的知识库维护者
常规风险
- 误删除风险:
delete命令无二次确认参数(除非借助--interactive),脚本中误传变量可能导致数据丢失 - 批量替换风险:
replace命令默认直接执行,建议始终先以--dry-run验证 - 密钥泄露风险:
~/.workflowy/api.key若备份至云同步盘或权限配置错误,存在凭证泄露隐患 - 数据一致性:
--method=export存在约1分钟缓存延迟,高频协作场景下可能读取过期状态