AI Coding Assistants¶
The Kreuzberg plugin teaches AI coding assistants how to use the library — covering extraction, configuration, OCR, chunking, embeddings, batch processing, error handling, and plugins across Python, Node.js/TypeScript, Rust, and CLI.
Installing¶
Install the Kreuzberg plugin from the kreuzberg-dev/plugins marketplace. It ships the Kreuzberg agent skills (extraction APIs, OCR backends, configuration, language conventions) and works with every major coding agent — expand your harness below.
Codex CLI
Then search for `kreuzberg` and select **Install Plugin**.Cursor
Settings → Plugins → Add from URL → `https://github.com/kreuzberg-dev/plugins`, then select **Kreuzberg**.Factory Droid
GitHub Copilot CLI
opencode
Add the package to `opencode.json`:What the Skill Provides¶
When your AI coding assistant discovers the skill, it knows:
- All extraction functions and their correct signatures across languages
- Configuration field names (for example,
max_charsnotmax_charactersin Python) - Rust feature gates (for example,
tokio-runtimefor sync functions) - Language-specific conventions (snake_case in Python/Rust, camelCase in Node.js)
- Error handling patterns for each language
Quick Examples¶
from kreuzberg import extract_file, extract_file_sync, ExtractionConfig, OcrConfig
result = await extract_file("document.pdf")
print(result.content)
config = ExtractionConfig(
ocr=OcrConfig(backend="tesseract", language="eng"),
output_format="markdown",
)
result = await extract_file("document.pdf", config=config)
Further Reading¶
- Plugin marketplace — install the plugin in every supported harness
- Extraction Basics — core extraction API
- Configuration — all configuration options
- Advanced Features — chunking, embeddings, language detection
- Plugin System — custom plugins