Command Line Interface Leave feedback

Installing groupdocs-parser-net also installs the groupdocs-parser command. It runs the same engine as the Python API, so you can pull text, metadata, images and annotations out of documents from a shell, a Make rule or a CI step without writing a script. If the Scripts (Windows) or bin (Linux, macOS) folder of your Python is not on PATH, run python -m groupdocs.parser instead; it takes the same arguments.

groupdocs-parser --version

groupdocs-parser 26.10.0

Run groupdocs-parser --help or groupdocs-parser <command> --help for the full list of flags.

groupdocs-parser text report.pdf                        # plain text to the console
groupdocs-parser text report.pdf --page 2 -o page2.txt  # one page, to a UTF-8 file
groupdocs-parser text report.docx --format markdown     # Markdown, or html
groupdocs-parser text scan.pdf --ocr                    # recognize text in scanned pages
groupdocs-parser text reviewed.docx --include-annotations
groupdocs-parser info report.pdf --json                 # format, pages, size
groupdocs-parser metadata report.docx                   # name = value
groupdocs-parser images report.pdf --out images/        # writes image-001.png, ...
groupdocs-parser annotations reviewed.docx --json       # comments with page, author and time
groupdocs-parser list-formats                           # every supported extension and family

groupdocs-parser --license license.lic text protected.pdf --password secret

info on a two-page PDF prints:

format:    Portable Document Format File
extension: .pdf
pages:     2
size:      150567

and with --json:

{
  "format": "Portable Document Format File",
  "extension": ".pdf",
  "pages": 2,
  "size": 150567
}

list-formats prints one line per file type:

.7z      ARCHIVE          7z Archive File
.azw3    EBOOK            AZW3
.bmp     IMAGE            Bitmap Image File
.bz2     ARCHIVE          Bzip2 Archive File
.chm     EBOOK            Compiled HTML Help File
...

metadata, images and annotations print a count such as # 9 properties to standard error, so standard output carries only the data and can be piped.

Errors are printed to standard error as one line, for example error: no such file: missing.pdf. A protected document opened without --password adds the hint -- pass --password.

Without a license the command runs in evaluation mode: text stops after about 20 lines and metadata returns the first 5 properties (see Licensing and evaluation limitations). Pass --license PATH or set the GROUPDOCS_LIC_PATH environment variable.

The command covers the common one-document tasks. Use the Python API for:

• template-based parsing (parse_by_template) and form data (parse_form);
• search, highlights, text areas, tables, hyperlinks, barcodes and the table of contents;
• documents in memory (streams) and documents inside archives and emails (get_container);
• logging and the external-resource handler (Logging, Handle loading of external resources);
• processing many documents in one process: the first document a process opens takes 20-30 seconds while the engine loads, and every groupdocs-parser run is a new process.