关于 overleaf
overleaf 技能通过 olcli 命令行管理 Overleaf LaTeX 项目,适合需要在本地编辑并与 Overleaf 同步的作者。它还支持编译、下载 PDF 和获取项目输出文件。
主要功能
- 01拉取、推送及双向同步项目
- 02上传和下载项目文件
- 03编译项目并下载 PDF
- 04获取 .bbl 等编译输出
- 05预览推送变更
适用场景
- 01在本地编辑论文并同步到 Overleaf
- 02编译并下载论文 PDF
- 03准备 arXiv 提交所需的 .bbl 文件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ aloth/ overleaf-skill --skill overleaf安装后在 Claude Code 中输入/overleaf确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
CITATION.cffREADME.mdpackage.jsonLICENSE.md.github/ISSUE_TEMPLATE/bug-report.ymlfeature-request.ymlreferences/API.mdscripts/install.sh详细介绍
Overleaf 技能
通过 olcli CLI 管理 Overleaf LaTeX 项目。
安装
# Homebrew (recommended)
brew tap aloth/tap && brew install olcli
# npm
npm install -g @aloth/olcli
身份验证
从 Overleaf 获取会话 Cookie:
- 登录 overleaf.com
- 打开 DevTools(F12)→ Application → Cookies
- 复制
overleaf_session2的值
olcli auth --cookie "YOUR_SESSION_COOKIE"
验证方式:
olcli whoami
排查身份验证问题:
olcli check
清除已存储的凭据:
olcli logout
常见工作流
拉取项目到本地进行编辑
olcli pull "My Paper"
cd My_Paper/
编辑并同步更改
# After editing files locally
olcli push # Upload changes only
olcli sync # Bidirectional sync (pull + push)
编译并下载 PDF
olcli pdf # Compile and download
olcli pdf -o paper.pdf # Custom output name
olcli compile # Just compile (no download)
下载用于 arXiv 投稿的 .bbl 文件
olcli output bbl # Download compiled .bbl
olcli output bbl -o main.bbl # Custom filename
olcli output --list # List all available outputs
上传图片或资源
olcli upload figure1.png "My Paper" # Upload to project root
olcli upload diagram.pdf # Auto-detect project from .olcli.json
下载指定文件
olcli download main.tex "My Paper" # Download single file
olcli zip "My Paper" # Download entire project as zip
arXiv 投稿工作流
准备 arXiv 投稿的完整工作流:
# 1. Pull your project
olcli pull "Research Paper"
cd Research_Paper
# 2. Compile to ensure everything builds
olcli compile
# 3. Download the .bbl file (arXiv requires .bbl, not .bib)
olcli output bbl -o main.bbl
# 4. Download any other needed outputs
olcli output aux -o main.aux # If needed
# 5. Package for submission
zip arxiv.zip *.tex main.bbl figures/*.pdf
# 6. Verify the package compiles locally (optional)
# Then upload arxiv.zip to arxiv.org
命令参考
| 命令 | 说明 |
|---|---|
olcli auth --cookie <value> | 使用会话 Cookie 进行身份验证 |
olcli whoami | 检查身份验证状态 |
olcli logout | 清除已存储的凭据 |
olcli check | 显示配置路径和凭据来源 |
olcli list | 列出所有项目 |
olcli info [project] | 显示项目详情 |
olcli pull [project] [dir] | 下载项目文件 |
olcli push [dir] | 上传本地更改 |
olcli sync [dir] | 双向同步 |
olcli upload <file> [project] | 上传单个文件 |
olcli download <file> [project] | 下载单个文件 |
olcli zip [project] | 下载为 zip 压缩包 |
olcli compile [project] | 开始编译 |
olcli pdf [project] | 编译并下载 PDF |
olcli output [type] | 下载编译输出文件 |
提示
- 自动检测项目:在已同步的目录(包含
.olcli.json)中运行命令,即可省略项目参数 - 试运行:使用
olcli push --dry-run在上传前预览更改 - 强制覆盖:使用
olcli pull --force覆盖本地更改 - 项目 ID:可以使用项目 ID 代替名称(URL 中的 24 位十六进制字符串)
- 排查身份验证问题:运行
olcli check查看凭据的加载来源
评论
支持 Markdown