Skip to content

Onr/overleaf-simple-local-folder-auto-sync

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Overleaf Auto Sync (Gum CLI)

A small, interactive CLI tool (built with Gum + Git) to keep a local folder and an Overleaf project in sync.

Use VS Code (or any editor) to write your LaTeX locally, while this script:

  • Clones or connects to your Overleaf Git project
  • Auto-commits local changes
  • Pulls remote changes from Overleaf
  • Pushes everything back on a configurable interval

All behind a friendly UI.

image

Overleaf VS Code demo


Requirements

  • bash
  • git
  • Gum (for the fancy TUI prompts)

Installation

  1. Copy the script into your repo (e.g., as overleaf_autosync.sh), or clone this repo.

  2. Install Gum.


Getting the Overleaf Git URL

In Overleaf:

  1. Open your project
  2. Go to Menu → Git
  3. Copy the Git URL (looks like https://git@git.overleaf.com/<project-id>)

You can paste that directly into the script when prompted.


Usage

1. Start the tool

From the directory where the script lives:

./overleaf_autoupdate.sh

The script will start an interactive Gum-based setup. Just follow the on-screen instructions.


Tips & Caveats

  • For big binary files or very large projects, frequent auto-commits + pushes may be problematic.

About

A lightweight command-line tool that sets up two-way syncing between a local folder and an Overleaf project. Use VS Code (or any local editor) to work on your LaTeX files, while the tool automatically handles git setup, remote linking, and background sync with Overleaf.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages