Installation¶

Polyglot SDKs plus a standalone CLI. Most packages ship prebuilt binaries for Linux (x86_64/aarch64), macOS, and Windows — no compile step needed.

curl -fsSL https://raw.githubusercontent.com/kreuzberg-dev/kreuzberg/main/scripts/install.sh | bash

brew trust kreuzberg-dev/tap
brew install kreuzberg-dev/tap/kreuzberg

cargo install kreuzberg-cli

docker pull ghcr.io/kreuzberg-dev/kreuzberg-cli:latest
docker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-cli:latest extract /data/document.pdf

docker pull ghcr.io/kreuzberg-dev/kreuzberg:latest

Choose your language¶

pip install kreuzberg

npm install @kreuzberg/node

npm install @kreuzberg/wasm

cargo add kreuzberg

go get github.com/kreuzberg-dev/kreuzberg/v5@latest

implementation 'dev.kreuzberg:kreuzberg:5.0.0-rc.17'

implementation("dev.kreuzberg:kreuzberg-android:5.0.0-rc.17")

gem install kreuzberg

.package(url: "https://github.com/kreuzberg-dev/kreuzberg.git", from: "5.0.0-rc.17")

dotnet add package Kreuzberg

composer require kreuzberg-dev/kreuzberg

{:kreuzberg, "~> 5.0.0-rc.17"}

install.packages("kreuzberg",
  repos = "https://kreuzberg-dev.r-universe.dev")

cargo build -p kreuzberg-ffi

dart pub add kreuzberg

zig fetch --save https://github.com/kreuzberg-dev/kreuzberg/archive/refs/tags/v5.0.0-rc.17.tar.gz

System requirements¶

Only relevant if building from source or enabling OCR:

PDF extraction uses pdf_oxide and has no external PDF runtime dependency.

The Wasm package (@kreuzberg/wasm) has zero system dependencies.

HEIF / HEIC / AVIF support¶

Pixel decoding for Apple HEIC photos, HEIF still images, AVIF, HEIC sequences (.heics), and AVCS requires the heic Cargo feature plus the system libheif library (with libde265 for HEVC and libaom for AV1):

• macOS: brew install libheif
• Debian / Ubuntu: apt install libheif-dev
• Fedora: dnf install libheif-devel
• Windows (vcpkg): vcpkg install libheif[hevc,aom]:x64-windows

Enable the feature when building from source:

kreuzberg = { version = "5", features = ["heic", "ocr"] }

heic is included in the full aggregate feature. HEIC pixel decoding is not available on wasm-target or android-target (libheif is a C library with no working WASM/Android build story). EXIF metadata extraction from HEIC / HEIF / AVIF works on every target via the pure-Rust nom-exif integration.

GPU Acceleration¶

Kreuzberg bundles a CPU-only ONNX Runtime — ML features (PaddleOCR, layout detection, embeddings, reranking, auto-rotate, transcription) work out of the box on CPU.

For GPU acceleration, install a GPU-enabled ONNX Runtime and set ORT_DYLIB_PATH:

See AccelerationConfig and ORT_DYLIB_PATH for details.

Language-specific notes¶

Edge cases and alternative install methods where they come up.

TypeScript¶

Two npm packages target different runtimes:

Both work with pnpm (pnpm add) and Yarn (yarn add) as well.

auto-install-peers=true

<script type="module">
  import { initWasm, extractFromFile } from "@kreuzberg/wasm";

  await initWasm();

  const input = document.getElementById("file");
  input.addEventListener("change", async (e) => {
    const result = await extractFromFile(e.target.files[0]);
    console.log(result.content);
  });
</script>

<input type="file" id="file" />

import { initWasm, extractFile } from "npm:@kreuzberg/wasm";

await initWasm();
const result = await extractFile("./document.pdf");
console.log(result.content);

import { initWasm, extractBytes } from "@kreuzberg/wasm";

export default {
  async fetch(request: Request): Promise<Response> {
    await initWasm();
    const bytes = new Uint8Array(await request.arrayBuffer());
    const result = await extractBytes(bytes, "application/pdf");
    return Response.json({ content: result.content });
  },
};

Supported runtimes: Chrome 74+, Firefox 79+, Safari 14+, Edge 79+, Node.js 22+, Deno 1.35+, Cloudflare Workers.

Java¶

<dependency>
    <groupId>dev.kreuzberg</groupId>
    <artifactId>kreuzberg</artifactId>
    <version>5.0.0-rc.17</version>
</dependency>

implementation 'dev.kreuzberg:kreuzberg:5.0.0-rc.17'

Requires Java 25+ (FFM/Panama API). Native libraries are bundled in the JAR.

Elixir¶

Add to mix.exs:

def deps do
  [
    {:kreuzberg, "~> 5.0.0-rc.17"}
  ]
end

mix deps.get

Ships prebuilt NIF binaries via RustlerPrecompiled. Falls back to compiling from source if no prebuilt matches your platform (requires Rust).

Go¶

go get github.com/kreuzberg-dev/kreuzberg/v5@latest

Rust¶

Enable features selectively in Cargo.toml:

[dependencies]
kreuzberg = { version = "5", features = ["pdf", "ocr", "chunking"] }
# Default features are tokio-runtime + simd-utf8; format and analysis features are opt-in.

C / C++¶

Build the FFI library from source:

cargo build --release -p kreuzberg-ffi

This produces libkreuzberg_ffi.a and a header at crates/kreuzberg-ffi/kreuzberg.h. Link into your project:

HEADER_DIR = path/to/crates/kreuzberg-ffi
LIBDIR     = path/to/target/release

CFLAGS  = -Wall -Wextra -I$(HEADER_DIR)
LDFLAGS = -L$(LIBDIR) -lkreuzberg_ffi -lpthread -ldl -lm

my_app: my_app.c
    $(CC) $(CFLAGS) -o $@ $< $(LDFLAGS)

API Reference →

Dart / Flutter¶

Pure-Dart and Flutter consumers share the same package. Dart SDK 3.0 or higher is required. Flutter is supported on macOS, iOS, Android, Linux, and Windows; Flutter Web is not supported because the runtime is a native dynamic library delivered via flutter_rust_bridge. For Flutter projects use flutter pub add kreuzberg instead of dart pub add kreuzberg.

Kotlin¶

Kotlin/JVM consumers use the Java artifact (dev.kreuzberg:kreuzberg) directly; Kotlin interoperates with the generated Java records and static facade.

Kotlin Android uses the Android AAR (dev.kreuzberg:kreuzberg-android). It embeds JNI libraries for arm64-v8a and x86_64, targets Android API 21+, and uses the android-target feature set, which excludes ORT-dependent inference features.

Swift¶

Swift Package Manager from swift-tools-version: 6.0 upward. Targets macOS 13+ and iOS 16+; Linux is not currently declared in Package.swift. Once the package ships its binaryTarget, no manual cargo build is needed; in the interim, building the library locally requires cargo build -p kreuzberg-swift against the workspace.

Zig¶

Requires Zig 0.16.0 or higher (declared via minimum_zig_version in build.zig.zon). The Zig binding consumes the C FFI surface from kreuzberg-ffi via linkSystemLibrary; the build expects the consumer to provide a search path to the prebuilt libkreuzberg_ffi and the C header kreuzberg.h. The zig fetch command above pins the source archive in build.zig.zon; wire it into build.zig via b.dependency("kreuzberg", ...).

Development setup¶

For working on the Kreuzberg repository itself:

task setup      # installs all language toolchains
task lint        # linters across all languages
task dev:test    # full test suite

See Contributing for conventions and expectations.

Edit this page on GitHub