mirrors/docling
1
0
Fork 0
mirror of https://github.com/DS4SD/docling.git synced 2025-07-30 14:04:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

update CLI docs

Browse Source 
Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
This commit is contained in:
Michele Dolfi 2024-11-02 09:44:34 +01:00
parent af32a049d4
commit 8902d1e208
1 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/usage.md
View File

@ -32,30 +32,37 @@ Here are the available options as of this writing (for an up-to-date listing, ru
```console ```console
$ docling --help $ docling --help
Usage: docling [OPTIONS] source Usage: docling [OPTIONS] source
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ ╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ * input_sources source PDF files to convert. Can be local file / directory paths or URL. [default: None] │ │ * input_sources source PDF files to convert. Can be local file / directory paths or URL. [default: None] │
│ [required] │ │ [required] │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ ╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --from [docx|pptx|html|image|pdf] Specify input formats to convert from. │ │ --from [docx|pptx|html|image|pdf|asciidoc|md] Specify input formats to convert from. │
│ Defaults to all formats. │ │ Defaults to all formats. │
│ [default: None] │ │ [default: None] │
│ --to [md|json|text|doctags] Specify output formats. Defaults to │ │ --to [md|json|text|doctags] Specify output formats. Defaults to │
│ Markdown. │ │ Markdown. │
│ [default: None] │ │ [default: None] │
│ --ocr --no-ocr If enabled, the bitmap content will be │ │ --ocr --no-ocr If enabled, the bitmap content will be │
│ processed using OCR. │ │ processed using OCR. │
│ [default: ocr] │ │ [default: ocr] │
│ --ocr-engine [easyocr|tesseract_cli|tesseract] The OCR engine to use. [default: easyocr] │ │ --ocr-engine [easyocr|tesseract_cli|tesseract] The OCR engine to use. │
│ --abort-on-error --no-abort-on-error If enabled, the bitmap content will be │ │ [default: easyocr] │
│ processed using OCR. │ │ --pdf-backend [pypdfium2|dlparse_v1|dlparse_v2] The PDF backend to use. │
│ [default: no-abort-on-error] │ │ [default: dlparse_v1] │
│ --output PATH Output directory where results are saved. │ │ --table-mode [fast|accurate] The mode to use in the table structure │
│ [default: .] │ │ model. │
│ --version Show version information. │ │ [default: fast] │
│ --help Show this message and exit. │ │ --abort-on-error --no-abort-on-error If enabled, the bitmap content will be │
│ processed using OCR. │
│ [default: no-abort-on-error] │
│ --output PATH Output directory where results are │
│ saved. │
│ [default: .] │
│ --version Show version information. │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
``` ```
</details> </details>