Mindee.Cli 4.2.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet tool install --global Mindee.Cli --version 4.2.1
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local Mindee.Cli --version 4.2.1
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Mindee.Cli&version=4.2.1
                    


                    

                
nuke :add-package Mindee.Cli --version 4.2.1

Mindee CLI for .NET

Simple command-line interface for the Mindee APIs.

Install

dotnet tool install --global Mindee.Cli
mindee -h

Authentication

Pass your API key with --api-key:

  • V2: mindee --api-key <V2_API_KEY> ...
  • V1: mindee v1 --api-key <V1_API_KEY> ...

You can also configure keys via environment variables:

  • V2: MindeeV2__ApiKey
  • V1: Mindee__ApiKey

V2 Usage (Latest)

V2 commands are top-level commands:

Products

  • classification : Classify tool
  • crop : Crop tool
  • extraction : Extraction tool (most common models)
  • ocr : OCR tool
  • split : Split tool

Tools

  • search-models

Inference syntax

mindee --api-key <V2_API_KEY> <command> --model-id <MODEL_ID> [options] <path>

Search-models syntax

mindee --api-key <V2_API_KEY> search-models [--name <NAME>] [--model-type <TYPE>] [--raw-json]

V2 examples

# List available extraction models
mindee --api-key <V2_API_KEY> search-models --model-type extraction

# Run an extraction model
mindee --api-key <V2_API_KEY> extraction --model-id <MODEL_ID> ./invoice.pdf --output full --raw-text

V1 (Legacy)

V1 commands are under the v1 namespace:

  • barcode-reader
  • cropper
  • financial-document
  • fr-bank-account-details
  • fr-carte-grise
  • fr-health-card
  • fr-carte-nationale-d-identite
  • fr-payslip
  • international-id
  • invoice
  • invoice-splitter
  • multi-receipts-detector
  • passport
  • receipt
  • us-bank-check

General syntax

mindee v1 --api-key <V1_API_KEY> <product> [options] <path>

V1 examples

# Run invoice parsing
mindee v1 --api-key <V1_API_KEY> invoice ./invoice.pdf --output summary

# Run async receipt parsing and print raw JSON
mindee v1 --api-key <V1_API_KEY> receipt ./receipt.jpg --async --output raw

Output Modes

For commands that support --output:

  • summary: basic summary (default)
  • full: detailed result
  • raw: full JSON response

Help

mindee -h
mindee <command> -h
mindee v1 -h
mindee v1 <product> -h

References

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
4.2.1 109 4/28/2026
4.2.0 97 4/22/2026
4.2.0-rc1 96 4/22/2026

CHANGELOG.md