workflowy
Use the unofficial workflowy CLI mholzen/workflowy to interact with the Workflowy API for managing a Workflowy outline. Requires API key setup.
Setup (once)
Get your API key at https://workflowy.com/api-key/, save it to ~/.workflowy/api.key, and ensure only your user can access it:
CODEBLOCK0
Alternatively, set the WORKFLOWY_API_KEY environment variable:
CODEBLOCK1
Common commands
Note: See the full command reference for more details.
Reading
CODEBLOCK2
Writing
CODEBLOCK3
Bulk operations
CODEBLOCK4
Statistics
CODEBLOCK5
Data Access Methods
| Method | Speed | Freshness | Use For |
|---|
| INLINECODE3 | Medium | Real-time | Specific items |
| INLINECODE4 |
Fast (cached) | ~1 min | Full tree access |
|
--method=backup | Fastest | Stale | Bulk ops, offline |
For offline mode, enable Workflowy's Dropbox backup:
CODEBLOCK6
Short IDs
Workflowy supports short IDs, obtained from the "Copy Internal Link" menu:
- - Web URL: INLINECODE6
- Can be used directly, e.g. INLINECODE7
Special named targets
- -
inbox — user's inbox - INLINECODE9 — root of outline
CODEBLOCK7
Notes
- - Deleting a node also deletes all its children
- Results are sorted by priority (display order)
- Use
--method=export for large tree operations (cached, faster) - Mirror analysis requires using the backup method
- Make sure to confirm before performing bulk replace operations
workflowy
使用非官方的 workflowy 命令行工具 mholzen/workflowy 与 Workflowy API 交互，用于管理 Workflowy 大纲。需要设置 API 密钥。
设置（一次性操作）
在 https://workflowy.com/api-key/ 获取 API 密钥，将其保存到 ~/.workflowy/api.key，并确保只有你能访问该文件：
bash
mkdir -p ~/.workflowy
echo 你的-api-密钥-在此 > ~/.workflowy/api.key
chmod 600 ~/.workflowy/api.key
或者，设置 WORKFLOWYAPIKEY 环境变量：
bash
export WORKFLOWYAPIKEY=你的-api-密钥-在此
常用命令
注意：查看完整的命令参考文档获取更多详细信息。
读取
bash
获取根节点（默认深度为2）
workflowy get
通过 UUID 或短 ID 获取特定节点
workflowy get <项目-id>
workflowy get https://workflowy.com/#/59fc7acbc68c
以扁平列表显示节点的子节点
workflowy list <项目-id>
搜索（全文搜索，不区分大小写）
workflowy search -i 会议记录
使用扩展正则表达式搜索
workflowy search -E
在子树内搜索
workflowy search bug --item-id <父节点-id>
写入
bash
向收件箱添加新节点
workflowy create 购买杂货 --parent-id=inbox
向特定父节点添加节点
workflowy create 任务 --parent-id=
更新节点
workflowy update <项目-id> --name 新名称
完成/取消完成
workflowy complete <项目-id>
workflowy uncomplete <项目-id>
移动节点
workflowy move <项目-id> <新父节点-id>
删除节点（包括其子节点！）
workflowy delete <项目-id>
批量操作
bash
搜索并替换（先进行试运行！）
workflowy replace --dry-run foo bar
workflowy replace --interactive foo bar
使用捕获组的正则表达式查找/替换
workflowy replace TASK-([0-9]+) ISSUE-$1
转换：按换行符拆分为子节点
workflowy transform <项目-id> split -s \n
转换：去除空白字符
workflowy transform <项目-id> trim
统计
bash
内容最多的地方在哪里？
workflowy report count --threshold 0.01
子节点最多的节点
workflowy report children --top-n 20
过时内容（最久未修改的）
workflowy report modified --top-n 50
镜像最多的节点（需要备份）
workflowy report mirrors --top-n 20
数据访问方法
| 方法 | 速度 | 新鲜度 | 用途 |
|---|
| --method=get | 中等 | 实时 | 特定项目 |
| --method=export |
快（缓存） | 约1分钟 | 完整树访问 |
| --method=backup | 最快 | 可能过时 | 批量操作，离线 |
对于离线模式，启用 Workflowy 的 Dropbox 备份：
bash
workflowy get --method=backup
短 ID
Workflowy 支持短 ID，可从复制内部链接菜单获取：
- - 网页 URL：https://workflowy.com/#/59fc7acbc68c
- 可直接使用，例如 workflowy get https://workflowy.com/#/59fc7acbc68c
特殊命名目标
- - inbox — 用户的收件箱
- home — 大纲根节点
bash
workflowy create 快速笔记 --parent-id=inbox
workflowy id inbox # 解析为 UUID
注意事项
- - 删除节点也会删除其所有子节点
- 结果按优先级排序（显示顺序）
- 对于大型树操作，使用 --method=export（缓存，速度更快）
- 镜像分析需要使用备份方法
- 执行批量替换操作前务必确认
