mistral_ocr 0.1.1

CLI tool to convert PDF, image, and document files into Markdown using Mistral AI's OCR API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

# Mistral OCR

A command-line tool to convert PDF, image, and document files into Markdown using [Mistral AI's OCR API](https://docs.mistral.ai/capabilities/document_ai/basic_ocr). Written in Rust.

## Features

- Supports PDF, images (jpg, png, gif, bmp, tiff, webp), and office documents (docx, odt, pptx, xlsx, etc.)
- Office documents are automatically converted to PDF via LibreOffice
- Multiple image handling modes:
  - **separate** — save images as files in a `_images/` directory
  - **inline** — embed images as base64 data URIs (single self-contained `.md` file)
  - **zip** — bundle markdown + images into a single `.zip` archive
- Single static binary, no runtime dependencies

## Installation

### Prerequisites

- A [Mistral API key](https://console.mistral.ai/)
- [LibreOffice](https://www.libreoffice.org/) (only needed for office document conversion)

### Pre-built binary (recommended)

```bash
cargo binstall mistral_ocr
```

### From source

```bash
cargo install mistral_ocr
```

## Configuration

Set your Mistral API key as an environment variable:

```bash
export MISTRAL_API_KEY='your-api-key-here'
```

## Usage

### Basic usage (text only)

```bash
mistral_ocr document.pdf
```

### Process an image

```bash
mistral_ocr photo.png
```

### Process a Word document

```bash
mistral_ocr report.docx --images inline
```

### Extract images as separate files

```bash
mistral_ocr document.pdf --images separate
```

### Single self-contained markdown file

```bash
mistral_ocr document.pdf --images inline
```

### Bundle everything into a zip

```bash
mistral_ocr document.pdf --images zip
```

### All options

```
<INPUT>               Path to the input file (required)
--model <MODEL>       Mistral OCR model name (default: mistral-ocr-latest)
--images <MODE>       How to handle images: none, separate, inline, zip (default: none)
--output <PATH>       Where to write the output (default: ocr_output.md)
```

### Supported file types

| Type | Extensions |
|------|-----------|
| PDF | pdf |
| Images | jpg, jpeg, png, gif, bmp, tiff, webp |
| Documents (via LibreOffice) | doc, docx, odt, rtf, txt, html, pptx, ppt, odp, xlsx, xls, ods, csv, epub |

## License

MIT — see [LICENSE](LICENSE).