work-with-overleaf

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Work With Overleaf

与Overleaf协作

Most academics keep their
.tex
in Overleaf, not on disk — so this skill gets an Overleaf project into a local working copy the rest of the toolkit can act on (
preflight-check
,
polish-prose
,
verify-citations
,
match-style
, …), then helps sync the changes back. It's the on-ramp; the other skills do the work.
大多数学者将其.tex文件存储在Overleaf而非本地磁盘上——因此本技能可将Overleaf项目导入本地工作副本,供工具集中的其他技能(如
preflight-check
polish-prose
verify-citations
match-style
……)处理,随后帮助将更改同步回Overleaf。它是衔接入口,具体工作由其他技能完成。

Pick the path that matches the account

选择与账户匹配的路径

Overleaf exposes three ways to move a project in and out. Re-verify the current method and whether it's premium before relying on it against Overleaf's live documentation, because account features and menu names can change. As of the last check:
PathWhoHow
Git integration (recommended)Premium / Server Pro 4.0+Project → Menu → Git; copy the
git clone https://git.overleaf.com/<id>
command. Authenticate with an Overleaf token (token-based auth). Work locally, then
git pull
/
git push
. Branch is
main
(older clones may be
master
).
GitHub synchronizationPremiumLink the project to a GitHub repo (Menu → GitHub); sync both ways. Run the skills on the GitHub clone you already have locally.
Download ZIPFree (everyone)Menu → Download → Source. Work locally; there is no auto-merge — re-upload changed files in the Overleaf editor, or paste edits back. Best for a one-shot check.
If the user isn't sure which they have, ask; don't assume premium.
Overleaf提供三种导入和导出项目的方式。在操作前,请对照Overleaf的实时文档重新验证当前方法及是否为高级账户,因为账户功能和菜单名称可能会发生变化。截至最后一次核查:
路径适用人群操作方式
Git集成(推荐)高级账户 / Server Pro 4.0+项目 → 菜单 → Git;复制
git clone https://git.overleaf.com/<id>
命令。使用Overleaf令牌进行身份验证(基于令牌的认证)。在本地处理后,执行
git pull
/
git push
。分支为
main
(旧版克隆可能为
master
)。
GitHub同步高级账户将项目链接至GitHub仓库(菜单 → GitHub);双向同步。在本地已有的GitHub克隆副本上运行相关技能。
下载ZIP文件免费账户(所有用户)菜单 → 下载 → 源文件。在本地处理;无自动合并功能——需在Overleaf编辑器中重新上传修改后的文件,或粘贴编辑内容。最适合一次性检查。
若用户不确定自己的账户类型,请询问,不要默认是高级账户。

Process

流程

  1. Establish the local copy. Determine the path above and get the project local (clone, use the existing GitHub clone, or unzip the download). Confirm the main
    .tex
    and
    .bib
    are present.
  2. Run the requested skills on the local files exactly as normal —
    preflight-check
    for desk-reject risk,
    polish-prose
    /
    match-style
    for the writing,
    verify-citations
    for the
    .bib
    ,
    assess-paper
    for the full read. Write outputs to
    paper-workspace/
    .
  3. Review changes before syncing. Show the author a diff of what changed. Never push automatically — academic drafts are shared/co-authored and an unreviewed push can clobber a collaborator's edits.
  4. Sync back by the same path:
    git push
    (Git integration), commit+push to the linked GitHub repo (sync), or tell the author exactly which files to re-upload (ZIP). For Git/GitHub, confirm first and surface any merge conflicts rather than forcing.
  5. Compile sanity. Note that Overleaf compiles server-side; if the local edits use a package/option Overleaf's TeX Live version may differ on, flag it so the author recompiles on Overleaf before relying on the PDF.
  1. 创建本地副本。确定上述路径并将项目导入本地(克隆、使用现有GitHub克隆副本,或解压下载的ZIP文件)。确认主.tex和.bib文件已存在。
  2. 运行请求的技能:完全按照常规方式在本地文件上运行技能——
    preflight-check
    用于检查退稿风险,
    polish-prose
    /
    match-style
    用于优化写作,
    verify-citations
    用于校验.bib文件,
    assess-paper
    用于全文审阅。将输出写入
    paper-workspace/
    目录。
  3. 同步前审阅更改:向作者展示更改差异。绝不要自动推送——学术草稿通常为多人协作编辑,未经审阅的推送可能会覆盖合作者的编辑内容。
  4. 同步回Overleaf:通过相同路径同步:
    git push
    (Git集成)、提交并推送到关联的GitHub仓库(同步),或明确告知作者需重新上传哪些文件(ZIP方式)。对于Git/GitHub路径,需先确认并显示任何合并冲突,而非强制推送。
  5. 编译合理性检查:注意Overleaf是在服务器端编译;如果本地编辑使用的包/选项与Overleaf的TeX Live版本不同,需标记此情况,以便作者在依赖PDF前在Overleaf上重新编译。

Guardrails

防护规则

  • The Overleaf token is a secret. Never print it, log it, write it to a file, or commit it. If a clone URL contains a token, redact it in any output.
  • Never auto-push or auto-upload without explicit confirmation — and never rewrite the Overleaf project history. Co-authors may be editing concurrently.
  • Don't assume premium. Git/GitHub paths are premium; if the user is on free Overleaf, use the ZIP path and say so.
  • Re-verify the live method (premium status, menu steps, clone host, branch name) against Overleaf's current docs before instructing — do not rely on cached steps.
  • Copilot, not pilot: propose the sync, show the diff, let the author run it.
  • Overleaf令牌是机密信息。绝不要打印、记录、写入文件或提交它。如果克隆URL包含令牌,需在任何输出中隐去该令牌。
  • 未经明确确认,绝不要自动推送或自动上传——且绝不要改写Overleaf项目的历史记录。合作者可能正在同时编辑。
  • 不要默认是高级账户。Git/GitHub路径仅适用于高级账户;如果用户使用的是免费版Overleaf,请使用ZIP路径并告知用户。
  • 重新验证实时操作方法(高级账户状态、菜单步骤、克隆主机、分支名称):在指导操作前,请对照Overleaf的当前文档进行验证——不要依赖缓存的步骤。
  • 角色为协作助手,而非主导者:提出同步建议,展示差异,让作者执行操作。

Memory

记忆功能

Uses the shared
.paper-memory/
convention (paper-memory-convention.md).
  • At start: read
    profile.yml
    /
    lessons.md
    for the author's usual Overleaf path so you don't re-ask each time.
  • At end: append
    date · work-with-overleaf · path used · note
    after deduping (e.g. "author uses Git integration, token in keychain").
  • Create
    .paper-memory/
    on demand; local-only, never uploaded; never store the token there.
遵循共享的
.paper-memory/
约定(paper-memory-convention.md)。
  • 开始时:读取
    profile.yml
    /
    lessons.md
    以了解作者常用的Overleaf路径,避免每次重复询问。
  • 结束时:去重后追加
    日期 · work-with-overleaf · 使用的路径 · 备注
    (例如:“作者使用Git集成,令牌存储在密钥链中”)。
  • 按需创建
    .paper-memory/
    目录;仅本地存储,绝不上传;绝不在此存储令牌。