CLI 参考
本页提供了我们命令行工具的文档。
docling
用法
docling [OPTIONS] source
选项
| 名称 | 类型 | 描述 | 默认值 |
|---|---|---|---|
--from |
选择 (docx | pptx | html | image | pdf | asciidoc | md | csv | xlsx | xml_uspto | xml_jats | json_docling) |
指定要从中转换的输入格式。默认为所有格式。 | 无 |
--to |
选择 (md | json | html | html_split_page | text | doctags) |
指定输出格式。默认为 Markdown。 | 无 |
--headers |
文本 | 指定在获取 URL 输入源时使用的 HTTP 请求头，格式为 JSON 字符串 | 无 |
--image-export-mode |
选择 (placeholder | embedded | referenced) |
文档的图片导出模式（仅适用于 JSON、Markdown 或 HTML）。在 placeholder 模式下，输出中仅标记图片的位置。在 embedded 模式下，图片以 base64 编码字符串的形式嵌入。在 referenced 模式下，图片以 PNG 格式导出并从主导出文档中引用。 |
ImageRefMode.EMBEDDED |
--pipeline |
选择 (standard | vlm) |
选择处理 PDF 或图片文件的管道。 | PdfPipeline.STANDARD |
--vlm-model |
选择 (smoldocling | granite_vision | granite_vision_ollama) |
选择用于 PDF 或图片文件的 VLM 模型。 | VlmModelType.SMOLDOCLING |
--ocr / --no-ocr |
布尔值 | 如果启用，位图内容将使用 OCR 进行处理。 | True |
--force-ocr / --no-force-ocr |
布尔值 | 将任何现有文本替换为通过完整内容生成的 OCR 文本。 | False |
--ocr-engine |
文本 | 要使用的 OCR 引擎。当未设置 --allow-external-plugins 时，可用值包括：easyocr, ocrmac, rapidocr, tesserocr, tesseract。使用 --show-external-plugins 选项可查看允许外部插件时的选项。 | easyocr |
--ocr-lang |
文本 | 提供 OCR 引擎使用的语言列表，以逗号分隔。请注意，每个 OCR 引擎对语言名称有不同的值。 | 无 |
--pdf-backend |
选择 (pypdfium2 | dlparse_v1 | dlparse_v2 | dlparse_v4) |
要使用的 PDF 后端。 | PdfBackend.DLPARSE_V2 |
--table-mode |
选择 (fast | accurate) |
在表格结构模型中使用的模式。 | TableFormerMode.ACCURATE |
--enrich-code / --no-enrich-code |
布尔值 | 在管道中启用代码增强模型。 | False |
--enrich-formula / --no-enrich-formula |
布尔值 | 在管道中启用公式增强模型。 | False |
--enrich-picture-classes / --no-enrich-picture-classes |
布尔值 | 在管道中启用图片分类增强模型。 | False |
--enrich-picture-description / --no-enrich-picture-description |
布尔值 | 在管道中启用图片描述模型。 | False |
--artifacts-path |
路径 | 如果提供，指定模型工件的位置。 | 无 |
--enable-remote-services / --no-enable-remote-services |
布尔值 | 使用连接到远程服务的模型时必须启用。 | False |
--allow-external-plugins / --no-allow-external-plugins |
布尔值 | 必须启用才能从第三方插件加载模块。 | False |
--show-external-plugins / --no-show-external-plugins |
布尔值 | 列出设置 --allow-external-plugins 选项时可用的第三方插件。 | False |
--abort-on-error / --no-abort-on-error |
布尔值 | 如果启用，遇到第一个错误时将中止处理。 | False |
--output |
路径 | 保存结果的输出目录。 | . |
--verbose, -v |
整数 | 设置详细级别。-v 用于信息日志，-vv 用于调试日志。 | 0 |
--debug-visualize-cells / --no-debug-visualize-cells |
布尔值 | 启用调试输出，可视化 PDF 单元格 | False |
--debug-visualize-ocr / --no-debug-visualize-ocr |
布尔值 | 启用调试输出，可视化 OCR 单元格 | False |
--debug-visualize-layout / --no-debug-visualize-layout |
布尔值 | 启用调试输出，可视化布局聚类 | False |
--debug-visualize-tables / --no-debug-visualize-tables |
布尔值 | 启用调试输出，可视化表格单元格 | False |
--version |
布尔值 | 显示版本信息。 | 无 |
--document-timeout |
浮点数 | 处理每个文档的超时时间，单位为秒。 | 无 |
--num-threads |
整数 | 线程数 | 4 |
--device |
选择 (auto | cpu | cuda | mps) |
加速器设备 | AcceleratorDevice.AUTO |
--logo |
布尔值 | Docling 标志 | 无 |
--help |
布尔值 | 显示此消息并退出。 | False |