MinerU Rust
中文 | English
Parse PDF, image, and Office documents into Markdown with a Rust library, CLI,
and HTTP API server. PDF rendering is implemented in Rust. The legacy CLI/API
and Python/Node run/parse paths use a remote MinerU-compatible VLM
(MinerU 3.4.5 protocol baseline); rich parsing also includes Rust-native CSV/TSV,
while other formats use a separate Python worker. The checked-in worker contract
is MinerU 4.2.3 / DocVortex 0.6.24. See compatibility.
Choose a route:
- Python or Node: install the published package and use
parse()for Markdown orrun()for the complete output tree. See the language examples. - Rich official SDK: use the Rust, Python, or Node SDK; CSV/TSV parse in Rust and other formats use a separately prepared worker. See the SDK guide for its runtime contract.
- Rust CLI / API server: install from crates.io, or build from a prepared checkout for the exact pinned sources. The published crate carries the optional-feature dependency advisories listed in compatibility.
- Local conversion: CLI
--backend localsupports clean text PDFs and selected legacy formats through the bundled Rust helper. It produces Markdown only, without layout JSON or a VLM call.
This checkout targets 0.5.0. Check the release guide for current package and release availability before installing a specific version.
See usage, compatibility,
SDK, and official HTTP API.
For a local Vulkan llama.cpp VLM server, see the Vulkan Compose guide.
Quickstart
Install Python (CPython 3.9+) or Node.js 18+, then configure a MinerU-compatible VLM endpoint. A general-purpose chat endpoint is not sufficient.
| Variable | Meaning | Example |
|---|---|---|
MINERU_VL_SERVER |
VLM service base URL | https://host/v1 |
MINERU_VL_MODEL_NAME |
Model ID | model-id |
MINERU_VL_API_KEY |
Bearer token | your-key |
# If required, enter the key without echoing it or saving it in shell history:
;
For the Python CLI, install the published wheel and run:
For Node.js, check the registry version and invoke its mineru-rs bin:
version=""
The full output tree is written to out/; use parse() when you only need
Markdown in memory, or run() to write that tree from application code.
Prefer the MINERU_VL_API_KEY environment variable over --api-key so the
key does not end up in shell history.
Python
Install mineru-rs with uv or pip on CPython 3.9+. Use parse() for
Markdown or run() for the complete output tree. The published wheel does not
include the Rust Office conversion helper. See the uv example
and SDK guide.
Node.js
Install @alexsun-top/mineru with npm or pnpm on Node.js 18+. Use parse()
for Markdown or run() for the complete output tree. The published package
does not include the Rust Office conversion helper. See the pnpm example
and SDK guide.
CLI and API server
Install from crates.io:
The published crate resolves its Office dependencies from crates.io, so the
office and legacy-office features pull dependency versions with open
advisories; read
compatibility
before enabling them. A default-feature build and local-inference are clean.
Alternatively build from a prepared source checkout. A source build produces
the mineru, mineru-api, and mineru-office-convert binaries. The
conversion capabilities are opt-in features. Run the preparation commands under
Build from source first; they are required before any
Cargo command in this checkout.
The legacy-office feature adds isolated local Markdown conversion for selected
legacy formats and clean text PDFs. It is not a local inference backend; uncertain
PDFs fail rather than generating layout output. See usage and
compatibility for supported inputs and backend details.
mineru-api is the HTTP API server: it accepts documents, calls the
configured VLM, and returns result archives. It performs no local inference.
# If required, enter the key without echoing it or saving it in shell history:
;
Keep the server bound to loopback or behind an authenticated reverse proxy: the task API has no built-in authentication or task ownership. See the usage guide for endpoints and complete options.
Build from source
Requires Rust 1.92+ and Python 3.9+. Prepare dependencies before any Cargo command in this checkout:
prepare fetches
hash-pinned source archives; verify checks the generated .deps/office-xml041/
tree offline. Do not edit that generated tree by hand. Install with
cargo install --path . --locked --features office,legacy-office.
Examples
License
MIT OR Apache-2.0. Model weights downloaded from Hugging Face are subject to the license shown on their model card.