olcli：在终端管理 Overleaf 项目

Overleaf CLI - pull, push, sync, compile LaTeX projects from your terminal. Git remote helper, MCP server for AI agents, and TypeScript l…

olcli — Overleaf CLI Command-line interface for Overleaf — Sync, manage, and compile LaTeX projects from your terminal. Work with Overleaf projects directly from your command line. Edit locally with your favorite editor, version control with Git, and sync seamlessly with Overleaf's cloud compilation. Features 📋 List all your Overleaf projects ✨ Create blank or example projects ⬇️ Pull project files to local directory for offline editing ⬆️ Push local changes back to Overleaf 🔄 Sync bidirectionally with smart conflict detection 🔍 Diff local files against the live remote before pushing 📝 Marked-up revisions — diff --latexdiff produces the struck-through/underlined PDF advisors and journals ask for 🔀 Git remote — use Overleaf as a native git remote (docs) ✌️ Two-way deletions — files removed locally are deleted on Overleaf on next sync 🗑️ Delete and ✏️ rename remote files by path 🚫 Smart ignore — LaTeX build artifacts and OS noise filtered automatically; extend with .olignore 📄 Compile PDFs using Overleaf's remote compiler 📦 Download individual files or full project archives 📤 Upload files to projects 💬 Review comments — list, add, resolve, reopen, delete, and reply to threads 🗂️ Preserve folder structure when pushing nested files ⏱️ Configurable timeout for slow connections 🔑 Password login for self-hosted instances (no browser required) ⚙️ Self-hosted Overleaf/ShareLaTeX support 📊 Output compile artifacts (.bbl, .log, .aux for arXiv submissions) 🤖 MCP server for AI assistants (docs) Perfect for: Editing LaTeX in your preferred text editor (Vim, VS Code, Emacs, etc.) Version control with Git while using Overleaf's compiler Automating workflows and CI/CD pipelines Offline work with periodic sync Installation Homebrew (macOS/Linux) brew tap aloth/tap brew install olcli npm (all platforms) npm install -g @aloth/olcli Or use with npx without installation: npx @aloth/olcli list For AI agents (via AgentSkills) npx skills add aloth/olcli Quick Start 1. Authenticate Session cookie (overleaf.com and self-hosted): olcli auth --cookie "your_session_cookie_value" Email/password (self-hosted without reCAPTCHA): olcli auth --email "[email protected]" # prompts for the password, so it stays out of your shell history The password is not stored unless you pass --save-password. A session cookie is saved either way and is what later commands use; the password only buys an automatic re-login once that cookie expires. For scripts, set OVERLEAF_EMAIL and OVERLEAF_PASSWORD — every command reads them, so a scripted run never needs olcli auth at all. 2. List Projects olcli list 3. Pull, Edit, Push olcli pull "My Thesis" cd My_Thesis/ vim main.tex olcli push 4. Compile PDF olcli pdf # Compile a specific .tex file (for multi-doc projects): olcli pdf -r appendix.tex 5. Or use native git commands git clone overleaf::https://www.overleaf.com/project/<id> cd <project> # edit, commit, push — standard git workflow git push See Git Remote Helper docs for details. Commands All commands auto-detect the project when run from a synced directory (contains .olcli.json). Command Description olcli auth Set session cookie or login with email/password olcli whoami Check authentication status olcli logout Clear the global config and the local .olauth, reporting each olcli list List all projects olcli info [project] Show project details and file list olcli pull [project] [dir] Download project files to local directory olcli push [dir] Upload local changes to Overleaf (--delete also removes files deleted locally) olcli sync [dir] Bidirectional sync (pull + push) olcli diff [project] [dir] Show content-level changes between local files and the remote olcli upload <file> [project] Upload a single file (--to <path> sets the remote destination) olcli download <file> [project] Download a single file olcli delete <file> [project] Delete a remote file or folder (alias: rm) olcli rename <old> <new> [project] Rename a remote file or folder (alias: mv) olcli project create <name> Create a blank or example project (--template blank|example) olcli project rename <new> [project] Rename the project itself (--dry-run) olcli project rename-bulk Rename many projects by pattern (dry-run unless --apply) olcli compile [project] Trigger PDF compilation olcli pdf [project] Compile and download PDF olcli output [type] Download compile output files olcli zip [project] Download project as zip archive olcli comments list [project] List comments (--status, --context, --concurrency); --changes also lists tracked changes (with --json the output becomes { comments, changes }) olcli changes accept <ids...> Accept tracked changes by id (--project, --json) olcli changes reject <ids...> Reject tracked changes by id; preview only unless --yes (--project, --json) olcli comments add <file> <msg> Add a comment to selected text olcli comments reply <id> <body> Reply to a comment thread olcli comments resolve <id> Resolve a comment thread olcli comments reopen <id> Reopen a resolved thread olcli comments delete <id> Delete a comment thread olcli ignored [dir] List ignore patterns in effect olcli config set-url <url> Set self-hosted base URL olcli config get-url Show the configured base URL olcli config set-cookie-name <name> Set session cookie name olcli config get-cookie-name Show the configured session cookie name olcli config set-timeout <ms> Set default HTTP timeout olcli config get-timeout Show the configured HTTP timeout olcli check Show config paths and credential sources Tracked changes are an Overleaf premium feature. They are only available in projects whose owner has a premium plan; invited collaborators can then use them regardless of their own plan. In other projects there are no tracked changes, so --changes returns an empty list and changes accept/changes reject report the ids as not found. See the Overleaf documentation for details. Compile Options The compile-related commands (compile, pdf, output) accept: Flag Description -r, --resource <path> Compile a speci