Command Line Interface

Command Line Usage

The CLI tool is provided mainly for quick tests and debugging.

General help

python3 -m mindee --help

Example command help

python3 -m mindee parse --help

Example parse command for Off-the-Shelf document

python3 -m mindee parse invoice --key xxxxxxx /path/to/invoice.pdf

Works with environment variables

export MINDEE_API_KEY=xxxxxx
python3 -m mindee parse invoice /path/to/invoice.pdf

Example parse command for a custom document

python3 -m mindee parse custom -a pikachu -k xxxxxxx pokemon_card /path/to/card.jpg

Example async parse command

python3 -m mindee parse invoice-splitter 

Full parsed output

python3 -m mindee invoice -o parsed /path/to/invoice.pdf

Running the script through shell

A helper script allows you to start the command directly:

./ -h


Join our Slack