Installation¶

Kreuzberg is composed of a core package and several optional dependencies, which users can install at their discretion.

System Dependencies¶

Pandoc¶

Kreuzberg relies on pandoc, which is a required system dependency. To install it, follow the instructions below:

Ubuntu/Debian¶

1

sudo apt-get install pandoc

macOS¶

1

brew install pandoc

Windows¶

1

choco install -y pandoc

Kreuzberg Core Package¶

The Kreuzberg core package can be installed using pip with:

1

pip install kreuzberg

Optional Features¶

OCR¶

OCR is an optional feature for extracting text from images and non-searchable PDFs. Kreuzberg supports multiple OCR backends. To understand the differences between these backends, please read the OCR Backends documentation.

Tesseract OCR¶

Tesseract OCR is built into Kreuzberg and doesn't require additional Python packages. However, you must install Tesseract 5.0 or higher on your system:

Ubuntu/Debian¶

1

sudo apt-get install tesseract-ocr

macOS¶

1

brew install tesseract

Windows¶

1

choco install -y tesseract

EasyOCR¶

EasyOCR is a Python-based OCR backend with wide language support and strong performance.

1

pip install "kreuzberg[easyocr]"

PaddleOCR¶

1

pip install "kreuzberg[paddleocr]"

Chunking¶

Chunking is an optional feature - useful for RAG applications among others. Kreuzberg uses the excellent semantic-text-splitter package for chunking. To install Kreuzberg with chunking support, you can use:

1

pip install "kreuzberg[chunking]"

All Optional Dependencies¶

To install Kreuzberg with all optional dependencies, you can use the all extra group:

1

pip install "kreuzberg[all]"

This is equivalent to:

1

pip install "kreuzberg[chunking,easyocr,paddleocr]"