Overleaf CLI - 从终端拉取、推送、同步、编译 LaTeX 项目。Git 远程辅助工具、用于 AI 代理的 MCP 服务器和 TypeScript 库。
概览
— 从终端同步、管理和编译LaTeX项目。 直接从命令行操作 Overleaf 项目。用你喜欢的编辑器本地编辑,用 Git 控制版本,并无缝同步 Overleaf 的云编译。 - 📋 所有 Overleaf 项目 - ✨ 空白或示例项目 - ⬇️ 项目文件存到本地目录以便离线编辑 - ⬆️ 本地更改返回 Overleaf - 🔄 双向且智能冲突检测 - 🔍 本地文件在推送🔀前对 live remote - — 将 Overleaf 作为原生 git 远程(docs)使用 - ✌️ 本地移除的文件在 Overleaf 下一次同步时删除 - 🗑️ 远程✏️文件按路径删除 - 🚫 LaTeX 构建伪影和操作系统噪声自动过滤;扩展 。
概述(AI 翻译)
Overleaf 命令行界面 — 从终端同步、管理和编译 LaTeX 项目。
直接从命令行操作 Overleaf 项目。用你喜欢的编辑器本地编辑,用 Git 控制版本,并无缝同步 Overleaf 的云编译。
特色
- 📋 列出你所有的Overleaf项目
- ✨ 创建空白或示例项目
- ⬇️ **将项目文件拉入本地目录以便离线编辑
- ⬆️ **将本地更改推回Overleaf
- 🔄 与智能冲突检测双向同步
- 🔍 **在推送前对实时远程进行本地文件差异处理
- 📝 标记修订 —
diff --latexdiff生成顾问和期刊要求的划线/下划线的PDF文件 - 🔀 Git 远程器 — 将 Overleaf 作为原生 git 远程使用(文档)
- ✌️ 双向删除 — 本地移除的文件在下一次同步时会在Overleaf上删除
- 🗑️ 删除并✏️重命名通过路径对远程文件进行
- 🚫 智能忽略 — LaTeX 构建伪影和操作系统噪声自动过滤;扩展时使用
.olignore - 📄 使用 Overleaf 的远程编译器编译 PDF
- 📦 下载单个文件或完整项目档案
本页由 AI 翻译,技术细节请以原文为准。
README
以下为原文 README 节选,完整内容请查看原文。
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 --latexdiffproduces 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,.auxfor 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 @aloth/olcli list