Guide · Agent skill
How to use the Overleaf Sync agent skill (overleaf-sync)
Updated · written with AI from the project's own documentation and checked against our catalogue data
overleaf-sync is an agent skill that keeps a local folder holding your LaTeX paper in step with an Overleaf project, using Overleaf's official Git bridge. It is written for people who co-author in the Overleaf web editor but also run ARIS audit tools on a local copy. After this guide you will know how to install the skill, run its one-time setup, and ask the agent to pull or push with a review step in between.
Quick start
- 1Check requirements. Confirm you have Git, an Overleaf Premium account with Git bridge access, your project ID or URL, and a supported credential store.
- 2Install the ZIP. Unzip overleaf-sync into ~/.claude/skills/ or a project's .claude/skills/ folder, or upload it under Settings → Capabilities → Skills in the Claude apps.
- 3Run setup yourself. In your own terminal, run the setup script with your project ID or URL, enter the token at the hidden prompt, then tell the agent 'setup done'.
- 4Pull before editing. Ask the agent to pull, then review each change it lists before anything is copied into paper/.
- 5Push after ARIS edits. Ask the agent to push, read the diff stat and sample hunks it shows, and confirm before it commits and pushes.
What the overleaf-sync skill makes the agent do
The skill connects a local paper directory with an Overleaf project. Collaborators keep editing in the Overleaf web UI, while ARIS workflows such as /paper-claim-audit, /citation-audit and /auto-paper-improvement-loop run on your local copy. Changes move in both directions through a separate clone called paper-overleaf/.
On a pull, the agent fetches remote edits, shows what changed, and decides per change whether to bring it in. On a push, it copies your local edits into the Overleaf clone, shows the changes, and commits and pushes only after you confirm.
- pull: fetch and review collaborator edits before merging them into paper/
- push: copy local edits into paper-overleaf/, show git diff --stat, then commit and push after confirmation
- status: report whether Overleaf is ahead, local is ahead, both differ, or everything is clean
Check the requirements before you install
The skill needs several things to be in place. Confirm each one before you start, because the setup step depends on them.
- Git
- An Overleaf Premium account with Git bridge access (the skill relies on the Premium Git bridge)
- Your Overleaf project ID or URL
- A credential store: macOS Keychain, Windows Credential Manager, or the Linux cache credential helper
- The ARIS repository tools tools/overleaf_setup.sh and tools/overleaf_audit.sh
- A bash shell
Install the skill by unzipping it or uploading it
Download the ZIP for overleaf-sync from this page. The package contains one file, SKILL.md. You can install it in one of two ways.
For Claude Code, unzip it into ~/.claude/skills/ to make it available everywhere, or into a project's .claude/skills/ folder to limit it to that project. For the Claude apps, upload the skill under Settings → Capabilities → Skills.
- Personal install: ~/.claude/skills/
- Project install: .claude/skills/ inside your project
- Claude apps: Settings → Capabilities → Skills
Run the one-time setup in your own terminal
Setup is the only step that involves your Overleaf token, and you run it yourself, not through the agent. The setup script refuses to run unless it is attached to a terminal, reads the token from a hidden prompt, strips the token from the remote URL after cloning, and stores it in your OS keychain.
The script also installs a pre-commit hook in paper-overleaf/.git/hooks/ that refuses to commit any content matching the token pattern olp_ followed by 20 or more letters or digits. When setup finishes, tell the agent 'setup done' and it will verify the clone without touching the token.
- The agent verifies the remote URL has no token, the credential helper is set, git fetch works without prompting, the pre-commit hook exists, and overleaf_audit.sh reports clean
- If paper-overleaf/ is empty because the Overleaf project is new, the agent then copies your local paper/ into it during push
bash <ARIS_REPO>/tools/overleaf_setup.sh <project-id-or-url>Pull collaborator edits without blind merging
Before each editing session, ask the agent to pull. It runs a fast-forward-only pull and lists the changed files and diffs in sec/*.tex. The skill tells the agent not to merge blindly, because collaborator edits often include half-finished sentences, typos, commented-out blocks, number changes and citation key changes.
The agent classifies each hunk. Clean editorial fixes sync directly. Number or claim changes sync and then trigger /paper-claim-audit. New citations trigger /citation-audit. Half-sentences and obvious typos are flagged for you rather than synced. New sections or restructures wait for your approval.
- Clean editorial improvement: sync, no audit needed
- Numerical or claim change: sync, then re-run /paper-claim-audit
- New \cite{...}: sync, then re-run /citation-audit
- Half-sentence or obvious typo: flag to you, do not auto-sync
- New section or restructure: stop and ask first
cd paper-overleaf && git pull --ff-onlyPush local edits with a confirmation gate
After ARIS has edited paper/, ask the agent to push. It pulls first to surface remote drift, mirrors paper/ into paper-overleaf/ while excluding build artifacts such as .aux, .log and .synctex.gz files, and shows git status and git diff --stat. It does not run git push until you confirm, unless you said auto: true at the start.
Commit messages name the ARIS skill that made the change, so collaborators can see where an edit came from. Examples from the skill include 'paper-write: regenerated sec/3.assurance after audit cascade refactor' and 'citation-audit: fix 14 metadata entries'.
- Pull happens first on every push
- Build artifacts are excluded from the mirror
- Nothing is pushed until you confirm
git add -A && git commit -m "<what ARIS changed and why>" && git pushSafety notes: scripts, network and the token
The skill runs shell scripts and makes network calls to Overleaf, so read it before you install it. Its allowed tools include Bash, and the source states that the agent never sees your authentication token. Keep it that way: do not paste the token into chat, and do not write it into env vars or files.
If a pull diverges from your local history, the skill does not auto-resolve. It tells the agent to stop and show you the differing commits. It also forbids git reset --hard and git push --force in conflict handling.
- Token is stored in the OS keychain, not in chat history or .git/config
- Divergence between remote and local stops the workflow for your decision
- The skill is MIT licensed
What people use it for
- Keep a co-author editing in Overleaf while you run /citation-audit on your local paper/ folder.
- Move an existing local LaTeX paper into a new Overleaf project so a collaborator can edit it.
- Review collaborator edits by hunk before they reach your working copy, with number changes re-audited.
- Check whether Overleaf and your local copy have diverged, using the status sub-command.
Frequently asked questions
Is the overleaf-sync skill free?
The skill is licensed under MIT, according to this page. Overleaf's Git bridge is a Premium feature, so you need an Overleaf Premium account with Git bridge access to use the skill.
What do I need to use overleaf-sync?
You need Git, an Overleaf Premium account with Git bridge access, your Overleaf project ID or URL, a credential store (macOS Keychain, Windows Credential Manager, or the Linux cache helper), the ARIS repository tools overleaf_setup.sh and overleaf_audit.sh, and a bash shell.
Where do I put the overleaf-sync skill folder?
Unzip the ZIP into ~/.claude/skills/ for a personal install or into a project's .claude/skills/ folder for a project-only install. In the Claude apps you can upload it under Settings → Capabilities → Skills instead.
Will the agent push my changes to Overleaf automatically?
No, not by default. The agent shows git diff --stat and a sample of prose changes, then waits for your explicit confirmation before it runs git push, unless you told it auto: true at the start.
Can the agent see my Overleaf token?
The source says the agent never sees the token. You paste it once into the terminal credential prompt during setup, and the OS keychain stores it from then on.
Does the source compare overleaf-sync with other tools?
No. The source describes how the skill works and what it needs, but it does not compare it with other Overleaf sync tools or give benchmarks, so check those yourself before choosing.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
overleaf-sync suits researchers and co-author teams who write in Overleaf with collaborators and also run ARIS audits locally, and who want a review step before remote edits reach their working copy. It is a poor fit if you do not have Overleaf Premium, want fully automatic syncing with no review, or are on a system without a supported credential store.
Download the skill