核心用法
workflowy-cli 是一款非官方的命令行工具,封装了 Workflowy 官方 API,允许用户在终端中直接操作大纲结构。核心功能覆盖四大场景:
数据读取:通过 get、list、search 命令获取节点树、子节点或全文检索;支持短 ID、URL 及特殊别名(inbox、home)定位。
内容写入:create、update、complete、move、delete 完成增删改查,其中删除操作会级联移除子节点。
批量处理:replace 支持正则替换与交互式确认,transform 提供拆分、去空格等结构化操作。
统计报表:内置节点数量、子节点分布、修改时间、镜像引用等多维度分析。
显著优点
- 灵活性高:支持正则搜索、捕获组替换、离线备份模式(
--method=backup),适合复杂内容治理。 - 效率优化:提供三种数据获取策略(实时、缓存导出、离线备份),兼顾速度与新鲜度。
- 集成友好:纯 CLI 输出,易于与 Unix 管道、脚本自动化及第三方工具链整合。
潜在局限
- 非官方工具:由社区开发者 mholzen 维护,非 Workflowy 官方出品,API 变更或功能弃用存在滞后风险。
- 安全风险:需将 API Key 明文存储于
~/.workflowy/api.key,无加密或密钥管理服务集成。 - 删除不可逆:
delete命令级联删除子节点且无回收站机制,误操作后果严重。 - 依赖外部备份:镜像分析功能依赖 Dropbox 备份开启,功能可用性受限。
适合人群
- 熟悉命令行工作流的 Workflowy 重度用户
- 需要批量内容迁移、格式清洗或自动化报告的知识库管理员
- 偏好本地脚本集成而非 Web 界面的效率工具爱好者
常规风险
- 凭证泄露:API Key 以明文存储,多用户系统或容器环境需额外权限管控。
- 数据丢失:批量替换与删除缺乏事务回滚,建议强制
--dry-run预览。 - 同步延迟:
export与backup模式存在 1 分钟至数小时的数据滞后,实时协作场景需谨慎选择模式。