overleaf

Overleaf スキル

olcli CLI を使って Overleaf の LaTeX プロジェクトを管理します。

インストール

# Homebrew (recommended)
brew tap aloth/tap && brew install olcli

# npm
npm install -g @aloth/olcli

認証

Overleaf からセッション Cookie を取得します。

1. overleaf.com にログインします
2. DevTools（F12）を開き、Application → Cookies に移動します
3. 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 文字の 16 進数）を使用できます
• 認証のデバッグ：olcli check を実行すると、認証情報の読み込み元を確認できます