Skip to content

v0.7.0 — Git Remote Helper

Latest

Choose a tag to compare

@aloth aloth released this 02 Jul 15:06

v0.7.0 — Git Remote Helper

Highlights

Use Overleaf projects as native git remotes. Clone, pull, and push with standard git commands — no wrapper scripts needed.

git clone overleaf::https://www.overleaf.com/project/<id>
cd <project>
# edit files locally...
git add . && git commit -m "update"
git push

New

  • git-remote-overleaf (#36) — a git remote helper implementing the import/export protocol. Originally proposed in #15 by @bicheTortue.
    • git clone downloads the full project as a single commit
    • git push uploads only changed/added files and deletes removed ones (incremental via marks)
    • git pull / git fetch detects up-to-date state without redundant downloads
    • Supports custom instances: overleaf::https://my-instance.com/project/<id>
    • Auth via OVERLEAF_SESSION env var or ~/.olauth file
    • Debug mode via GIT_REMOTE_OVERLEAF_DEBUG=1
    • State stored in .git/overleaf/ (marks + manifest)

How It Works

The helper speaks git's fast-import/fast-export protocol with mark-based tracking. On clone/fetch it downloads a project zip and emits a fast-import stream. On push it parses the fast-export stream to determine file modifications and deletions, then calls the Overleaf API to apply them.

Improved

  • README restructured — extracted MCP docs to docs/MCP.md and git remote docs to docs/GIT-REMOTE.md
  • Landing page (docs/index.html) updated with dynamic badges, git remote feature, and MCP section
  • SKILL.md updated with git remote, MCP, comments, and "when to use which mode" decision table

Install

After npm i -g @aloth/olcli, the binary git-remote-overleaf is on PATH. Any overleaf:: URL is automatically handled.