核心用法
tencent-docs-markdown 是一款面向腾讯文档生态的 Markdown 管理工具,提供完整的文档生命周期操作:新建并写入内容、创建空文档、下载为本地 .md 文件、读取在线内容、更新覆盖、删除(移入回收站)、重命名及获取文档元信息。
关键工作流:
- 认证:首次使用需微信/QQ扫码登录,Cookie 自动缓存于
.cookies.json,支持快捷登录检测 - URL 解析:自动将腾讯文档 URL 标识符(
DSxxxxxxxx)解析为 API 所需的真实padId,用户无感知 - 双模式支持:命令行 CLI 与编程接口并重,适合自动化脚本与 Agent 集成
典型场景:
- 本地 Markdown 批量同步至腾讯文档
- 云端文档自动备份到本地 Git 仓库
- Agent 驱动的文档协作(如"帮我新建文档并写入会议纪要的摘要")
显著优点
1. 全功能覆盖:涵盖 CRUD 完整操作,支持文件路径与文本内容双模式输入
2. 智能登录:自动检测微信快捷登录,减少扫码次数;Cookie 失效自动重登
3. URL 透明化:内置 resolveRealPadId() 自动处理腾讯文档的标识符映射问题
4. MIT 开源:可自由二次开发,适合构建企业级文档工作流
5. Agent 友好:预定义触发短语与 Mermaid 流程图,降低 LLM 集成成本
潜在缺点与局限性
- 强依赖腾讯生态:仅支持腾讯文档 Markdown(doc_type=14),不兼容其他云文档平台
- Cookie 安全风险:凭据以明文 JSON 存储于本地,多用户环境需额外防护
- 无版本控制:更新操作为覆盖式写入,无自动历史版本保留
- 回收站非彻底删除:"删除"仅移至回收站,需手动清空
- _rate limit 未披露_:高频 API 调用可能触发平台限流
适合人群
- 需将本地 Markdown 工作流与腾讯文档打通的技术写作者
- 构建办公自动化 Agent 的开发者
- 团队协作中需要批量文档管理的管理员
- 依赖微信/QQ 生态的企业用户
常规风险
| 风险类型 | 说明 | 缓解建议 |
|---------|------|---------|
| 会话劫持 | `.cookies.json` 泄露可导致账号被盗用 | 设置文件权限 600,勿提交至 Git |
| 误操作覆盖 | `update` 命令无确认直接覆盖 | 操作前手动备份或使用 Git 管理本地副本 |
| 平台依赖 | 腾讯 API 变更可能导致功能失效 | 关注上游更新,锁定版本号 |
| 隐私合规 | 文档内容经腾讯服务器处理 | 敏感内容建议本地加密后再上传 |