mcpField
W
work-with-overleaf

work-with-overleaf

github.com/shaishavmaisuria文档处理5790 次安装4 天前更新
代码仓库

关于 work-with-overleaf

用于将 Overleaf 学术论文项目复制到本地,以便其他论文工作技能处理,并在作者审阅后同步改动。它按 Git、GitHub 同步或 ZIP 下载路径指导操作,并避免未经确认推送。

主要功能

  1. 01通过 Git、GitHub 或 ZIP 获取项目
  2. 02在本地运行论文工作技能
  3. 03审阅差异后再同步修改
  4. 04保护令牌并避免自动推送

适用场景

  1. 01在本地检查或润色 Overleaf 论文
  2. 02通过 Git 或 GitHub 同步协作项目
  3. 03使用 ZIP 处理一次性检查

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/shaishavmaisuria/research-paper-lifecycle-skills --skill work-with-overleaf

安装后在 Claude Code 中输入/work-with-overleaf确认已加载。

附带文件scripts/overleaf_status.py

详细介绍

使用 Overleaf

大多数学者都把 .tex 文件放在 Overleaf 上,而不是本地磁盘上——因此,这项技能会将 Overleaf 项目下载到本地工作副本中,供工具包中的其他工具使用(preflight-check、polish-prose、verify-citations、match-style 等),然后帮助将更改同步回去。这是入门环节;实际工作由其他技能完成。

选择与账户相符的路径

Overleaf 提供三种导入和导出项目的方式。使用前,请根据 Overleaf 的实时文档重新确认当前方式及其是否为高级功能,因为账户功能和菜单名称可能会变化。截至上次检查:

路径适用对象操作方式
Git 集成(推荐)Premium / Server Pro 4.0+项目 → Menu → Git;复制 git clone https://git.overleaf.com/<id> 命令。使用 Overleaf 令牌进行身份验证(基于令牌的身份验证)。在本地工作,然后运行 git pull / git push。分支为 main(较早的克隆可能使用 master)。
GitHub 同步Premium将项目关联到 GitHub 仓库(Menu → GitHub);双向同步。在已有的本地 GitHub 克隆上运行这些技能。
下载 ZIP免费(所有人)Menu → Download → Source。在本地工作;不会自动合并——请在 Overleaf 编辑器中重新上传更改过的文件,或将修改后的内容粘贴回去。适合一次性检查。

如果用户不确定自己使用的是哪种方案,请先询问;不要假设其拥有高级功能。

流程

  1. 建立本地副本。 确定上述路径,并将项目下载到本地(克隆、使用已有的 GitHub 克隆,或解压下载的文件)。确认主 .tex 文件和 .bib 文件都存在。
  2. 按常规在本地文件上运行所需技能——使用 preflight-check 检查被编辑部拒稿的风险,使用 polish-prose/match-style 润色写作,使用 verify-citations 检查 .bib,使用 assess-paper 通读全文。将输出写入 paper-workspace/。
  3. 同步前检查更改。 向作者展示更改内容的 diff。绝不要自动推送——学术草稿由多人共同撰写和共享,未经审阅的推送可能覆盖合作者的修改。
  4. 通过相同路径同步回去:使用 Git 集成时运行 git push;使用同步时,向关联的 GitHub 仓库提交并推送;使用 ZIP 时,明确告知作者需要重新上传哪些文件。使用 Git/GitHub 时,先确认,再指出任何合并冲突;不要强行覆盖。
  5. 编译检查。 请注意,Overleaf 在服务器端编译;如果本地修改使用的宏包或选项可能与 Overleaf 的 TeX Live 版本不兼容,请提醒作者先在 Overleaf 上重新编译,再依赖生成的 PDF。

安全措施

  • Overleaf 令牌是机密信息。 绝不要打印、记录、写入文件或提交该令牌。如果克隆 URL 中包含令牌,请在任何输出中将其删去。
  • 未经明确确认,绝不要自动推送或自动上传,也绝不要重写 Overleaf 项目历史。合作者可能正在同时编辑。
  • 不要假设用户拥有高级功能。 Git/GitHub 路径需要高级功能;如果用户使用的是免费版 Overleaf,请使用 ZIP 路径并说明原因。
  • 在提供操作说明前,根据 Overleaf 当前文档重新确认实时方法(高级功能状态、菜单步骤、克隆主机、分支名称);不要依赖缓存的步骤。
  • 副驾驶,而非自动驾驶:提出同步方案,展示 diff,让作者自行执行。

记忆

使用共享的 .paper-memory/ 约定(paper-memory-convention.md)。

  • 开始时: 读取 profile.yml/lessons.md,了解作者通常使用的 Overleaf 路径,避免每次都重新询问。
  • 结束时: 去重后追加 date · work-with-overleaf · path used · note(例如“作者使用 Git 集成,令牌保存在密钥链中”)。
  • 按需创建 .paper-memory/;仅保存在本地,绝不上传;不要在其中存储令牌。

评论

支持 Markdown