drive +pull

前置条件： 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

把飞书云空间的某个文件夹单向、文件级镜像到本地目录（Drive → 本地）。命令递归列出 --folder-token 下所有 type=file 的文件，逐一下载到 --local-dir 对应的相对路径，子文件夹自动复刻为本地目录。

⚠️ 不是 directory-level mirror：--delete-local 只删除本地"多余"的常规文件，不删除空目录。如果云端把整个子文件夹删了，对应的本地子目录会留空（里面的文件被清掉，目录本身保留）；想精确同步目录结构请自己 rmdir 处理空壳。

输出按"动作"分类：

字段	含义
`summary.downloaded`	成功下载的文件数
`summary.skipped`	按 `--if-exists=skip` 跳过的文件数
`summary.failed`	下载或写盘失败的文件数
`summary.deleted_local`	启用 `--delete-local --yes` 时删除的本地文件数
`items[]`	每个文件的明细（`rel_path` / `file_token` / `action` / 失败时的 `error`）

summary.failed > 0 时命令以 非零状态码（exit=1，error.type=partial_failure）退出，且同一份 summary + items 会在 error.detail 里返回；脚本/agent 直接通过 exit code 判断成败即可，不需要再去解 summary.failed。

命令

# 基础用法 —— 把云端 fldcXXX 镜像到 ./repo
lark-cli drive +pull --local-dir ./repo --folder-token fldcnxxxxxxxxx

# 已存在的本地文件保持不动
lark-cli drive +pull --local-dir ./repo --folder-token fldcnxxxxxxxxx \
  --if-exists skip

# 文件级镜像：下载新文件 + 删除云端没有的本地文件（不删空目录）
# （--delete-local 必须搭配 --yes，否则会被 Validate 直接拒绝）
lark-cli drive +pull --local-dir ./repo --folder-token fldcnxxxxxxxxx \
  --delete-local --yes

参数

标志	必填	类型	说明
`--local-dir`	是	path	本地根目录（必须是 cwd 的相对路径；绝对路径或逃出 cwd 的相对路径会被 CLI 直接拒绝）
`--folder-token`	是	string	源 Drive 文件夹 token
`--if-exists`	否	enum	本地文件已存在时的策略：`overwrite`（默认）/ `skip`
`--delete-local`	否	bool	删除本地"云端没有的常规文件"（不删空目录，因此是 file-level mirror）；必须配合 `--yes`
`--yes`	否	bool	确认 `--delete-local`；不传时该破坏性操作在 Validate 阶段被拒绝

比较与下载范围

只下载 Drive type=file 的二进制文件。在线文档（docx / sheet / bitable / mindnote / slides）和快捷方式（shortcut）会被跳过 —— 它们没有等价的本地二进制可写盘，否则会变成产生噪声的"假"下载。
子文件夹会递归遍历；rel_path 形如 sub1/sub2/file.txt，本地缺失的父目录会被自动创建。
已存在的本地文件按 --if-exists 决定 overwrite 还是 skip，没有第三种选择 —— 想做 keep-both 这类的请自己改名再 pull。

--delete-local 的安全行为

--delete-local 是命令里唯一的破坏性 flag，会按"本地有但云端没有"清理本地常规文件。设计上把它跟 --yes 强绑定，且与下载阶段的失败联动：

--delete-local（无 --yes）→ Validate 直接报错：--delete-local requires --yes，没有任何下载、列表请求或删除发生。
--delete-local --yes，且下载阶段全部成功 → 扫一遍 --local-dir 下所有常规文件，把不在云端清单里的逐个 os.Remove。只删常规文件，不删目录：远端文件夹被删除后，对应本地目录会保留空壳。
--delete-local --yes，但下载阶段有任何条目失败 → 跳过整个删除阶段，命令以 partial_failure 非零退出。设计意图：避免出现"前面下载失败、后面继续删本地文件"的半同步状态；操作者修好下载错误后再重跑即可。
不传 --delete-local → summary.deleted_local 永远是 0；命令对本地"多余"文件视而不见。

第 6 章里把 +pull --delete-local 标了 high-risk-write，CLI 这边的实现等价于"未传 --yes 时拒绝执行"，符合该约束的精神。

输出 schema

{
  "summary": {
    "downloaded": 0,
    "skipped": 0,
    "failed": 0,
    "deleted_local": 0
  },
  "items": [
    {"rel_path": "...", "file_token": "...", "action": "downloaded"},
    {"rel_path": "...", "file_token": "...", "action": "skipped"},
    {"rel_path": "...", "file_token": "...", "action": "failed", "error": "..."},
    {"rel_path": "...", "action": "deleted_local"},
    {"rel_path": "...", "action": "delete_failed", "error": "..."}
  ]
}

rel_path 始终用 / 作为分隔符（跨平台一致）。删除条目（deleted_local / delete_failed）没有 file_token，因为该文件本来就只在本地。

性能注意

下载流量 ≈ 云端待下载文件的总字节数。pull 是全量写盘 —— 跟 +status 不一样，不会跳过"内容相同"的文件（status 是按 hash 比较，pull 是按 --if-exists），所以一次跑可能很重。
想避免重跑全量，可以先 +status 找出 new_remote 和 modified，再只对这些文件单独 +download。
大文件会用 SDK 的流式下载（不会把整个 body 读进内存），但本地磁盘空间需要够。

所需 scope

操作	scope
列出文件夹 / 子目录	`drive:drive.metadata:readonly`
下载文件	`drive:file:download`

如果当前 token 缺这些 scope，命令会直接报 missing_scope 并提示重新登录。drive:drive 在部分企业被策略禁用，所以 +pull 故意只声明上面这两个细粒度 scope。

范围限制

--local-dir 只接受 cwd 内的相对路径。CLI 会先 EvalSymlinks 整条路径，再判断它是否仍落在 cwd 内 —— 指向 cwd 外的符号链接也会被拒，"在 cwd 内放一条软链指向外面" 这条捷径走不通，会直接撞上 unsafe file path。

如果用户想 pull 到 cwd 之外的目录，不要 agent 自己 cd 绕过。可以选：让用户在外部把 agent 工作目录切换到目标的祖先后重启会话；或者把目标整体物理移动 / 拷贝到 cwd 内（不是软链）；或者直接放弃这次同步，改用别的方式。

参考

lark-drive —— 云空间全部命令
lark-shared —— 认证和全局参数
lark-drive-status —— 下载前先看差异
lark-drive-download —— 单文件按需拉取

6.7 KiB Raw Permalink Blame History Unescape Escape