すべてのオプションを検索#
キーワードを入力するか(/ で検索欄に移動)、グループで絞り込みます。既定値は CLI 自身のもので、コード表記の値が受け付けられる選択肢です。説明文はターミナルの表示と同じ英語の原文のままです。
構文#
docling convert [OPTIONS] SOURCE
docling SOURCE [OPTIONS] # 同じ意味(convert が既定のコマンド)
docling options {ocr|layout|table-structure} [ENGINE]
docling --versionSOURCE にはファイルパス、フォルダ(再帰的にたどり --from で絞り込み)、http(s) の URL を指定できます。出力ファイルは入力名に基づいて --output(既定はカレントフォルダ)に書き出されます。
検証済みのコマンド例#
いずれも Docling 2.148.0 で実行しました。ファイル名はご自身のものに置き換えてください。
形式と出力
docling convert report.pdf --to md --to json --output out/docling convert ./inbox --from pdf --to md --output ./outdocling convert report.pdf --to md --output-file report.mddocling convert report.pdf --page-range 1-10docling convert report.pdf --to md --image-export-mode referenced --output out/docling convert report.pdf --to html_split_page --show-layoutOCR
docling convert report.pdf --no-ocrdocling convert scan.pdf --ocr-mode full_pagedocling convert contract.pdf --replace-broken-text-layerdocling convert scan.pdf --ocr-engine rapidocr --ocr-option backend=torch --ocr-lang iso:jadocling convert scan.pdf --ocr-engine tesseract --ocr-lang jpn,eng表・拡張・モデル
docling convert report.pdf --table-mode fastdocling convert report.pdf --heading-hierarchydocling convert paper.pdf --enrich-formula --enrich-codedocling convert report.pdf --pipeline vlm --vlm-model granite_doclingdocling convert meeting.mp3 --pipeline asr --asr-model whisper_turbo --to md --to vttRAG と自動化
docling convert report.pdf --to chunks --chunks-max-tokens 512 --output chunks/docling convert ./inbox --to json --quiet --fail-on partial --output ./outdocling convert report.pdf --profilingoptions コマンド#
エンジンには専用オプション以外の設定もあります。docling options でステージごとのエンジンと受け付けるキーを一覧し、対応する --*-option KEY=VALUE で渡します。値は可能なら JSON として解釈されます(0.6、false、["en","de"])。
docling options ocr # auto easyocr kserve_v2_ocr nemotron-ocr ocrmac rapidocr tesserocr tesseract
docling options layout # layout_object_detection docling_layout_default docling_experimental_table_crops_layout
docling options table-structure # docling_tableformer docling_tableformer_v2 granite_vision_table
docling options ocr rapidocr # キー:mode・lang・scale・backend・model_size・text_score などdocling convert scan.pdf --ocr-engine rapidocr --ocr-option backend=torch --ocr-option model_size=tiny --ocr-option text_score=0.6終了コード#
--fail-on | 終了コード 1 になる条件 |
|---|---|
failure(既定) | いずれかの文書が失敗 |
partial | 失敗または部分的な変換がある |
never | なし(常に 0) |
既定ではフォルダ変換中にファイルが失敗しても続行します。最初の失敗で止めるには --abort-on-error を付けます。
非推奨・名称変更されたオプション#
古いチュートリアルのコマンドがうまく動かないときは、まずこの表を確認してください。
| 旧 | 2.148.0 での書き方 | 理由 |
|---|---|---|
--force-ocr | --ocr-mode full_page | CLI ヘルプで DEPRECATED と表示 |
--psm N | --ocr-option psm=N | DEPRECATED。エンジン設定は --ocr-option に移動 |
--ocr-lang chinese / english(RapidOCR) | --ocr-lang ch / en、または iso:zh-Hans | 旧表記も警告付きで解釈される |
リモート変換#
service-client を入れると、CLI に docling convert-remote が加わります。文書を docling-serve サーバーに送り、結果を手元に書き出します。PyTorch は不要で、当サイトの環境では 258 MB でした。
pip install "docling-slim[service-client]"
export DOCLING_SERVICE_URL=http://localhost:5001
export DOCLING_SERVICE_API_KEY=... # サーバーが要求する場合のみ
docling convert-remote report.pdf --to md --output out/環境変数#
| 変数 | 効果 |
|---|---|
DOCLING_ARTIFACTS_PATH | 事前ダウンロードしたモデルのフォルダ(--artifacts-path と同じ) |
DOCLING_SERVICE_URL・DOCLING_SERVICE_API_KEY | convert-remote のサーバーとキー |
OMP_NUM_THREADS | 内部の数値計算ライブラリのスレッド数を制限 |
よくある質問
Docling の基本コマンドは?
docling convert file.pdf で PDF を Markdown に変換し、カレントフォルダに保存します。--to json や --to html などで形式を追加し、--output DIR で出力先を指定します。
Docling CLI で OCR を無効にするには?
--no-ocr を付けます。すでにテキストを含む PDF ではこれが正解で、当サイトのベンチマークでは 3.6 倍速くなりました。
フォルダごと変換するには?
フォルダを SOURCE に指定します:docling convert ./inbox --to md --output ./out。--from pdf で PDF だけを対象にし、--abort-on-error で最初の失敗時に停止します。
OCR エンジンのオプションを確認するには?
docling options ocr ENGINE を実行します(例:docling options ocr rapidocr)。--ocr-option KEY=VALUE で渡せるキーが、型と既定値付きで表示されます。
docling convert の終了コードは?
既定ではいずれかの文書が失敗すると 1 で終了します。--fail-on partial は部分変換でも失敗とし、--fail-on never は常に 0 で終了します。