Skip to main content

MinerU Rust

English | 简体中文

Rust client library, command-line tools, and local API server for parsing PDF, image, and Office documents with an external OpenAI-compatible MinerU VLM service. PDF rendering uses pure Rust; no model is downloaded or run locally.

Within the MinerU 3.4.4 VLM scope, MinerU Rust is a drop-in replacement for the MinerU Python SDK's vlm-http-client path and can replace that VLM workflow completely. It does not implement or claim compatibility with non-VLM backends. See the compatibility contract, the Chinese usage guide, and the English usage guide. Document-limit controls and their CLI/API applicability are summarized in the usage guides.

Requires Rust 1.89 or newer.

Rust library

cargo add mineru
use mineru::{ClientConfig, MinerUClient, ParseOptions, PdfInput};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = MinerUClient::new(ClientConfig::new(
        "https://example.test/v1",
        "model-id",
    )?)?;
    let document = client
        .parse_pdf(PdfInput::Path("input.pdf".into()), ParseOptions::default())
        .await?;
    println!("{} pages", document.pages.len());
    Ok(())
}

CLI and API server

cargo install mineru
mineru --help

The package installs the mineru, mineru-api, mineru-vlm, and mineru-vlm-api binaries. To also install the mineru-office-convert Office conversion helper, build with --features office:

cargo install mineru --features office

See the Chinese usage guide or English usage guide for service configuration and complete options.

Python

Wheels support CPython 3.9 and newer:

pip install mineru-rs

The wheel installs two equivalent console commands, mineru and mineru-rs, both entering mineru_rs._cli:main. The mineru-rs name makes uvx mineru-rs --help work without a local checkout. Prefer mineru-rs when the upstream Python mineru package is also installed, since both provide a mineru entry point and the one earlier on PATH wins.

import mineru_rs

print(mineru_rs.canonical_stem("a bad/pdf"))
mineru_rs.validate_pdf_options(0, None, True, True, True)

Python currently exposes only canonical stem handling and PDF-option validation. It does not expose asynchronous document parsing. Releases are wheels only; there is no sdist or source fallback for unsupported platforms or PyPy.

Node.js

npm install @alexsun-top/mineru

The root package installs two equivalent binaries, mineru and mineru-rs, both pointing at bin/mineru.js, so node_modules/.bin/mineru-rs is available after install. The six platform packages intentionally ship no binary. Prefer mineru-rs if another mineru command is already on PATH.

const mineru = require('@alexsun-top/mineru')

console.log(mineru.canonicalStem('a bad/pdf'))
mineru.validatePdfOptions(0, null, true, true, true)

Node.js currently exposes only canonical stem handling and PDF-option validation. It does not expose asynchronous document parsing. Node.js 18 or newer is required.

License

Licensed under either Apache-2.0 or MIT, at your option.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

mineru_rs-0.2.3-cp39-abi3-win_amd64.whl (35.5 MB view details)

Uploaded CPython 3.9+Windows x86-64

mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (40.7 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (38.8 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ ARM64

mineru_rs-0.2.3-cp39-abi3-macosx_11_0_arm64.whl (37.5 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

mineru_rs-0.2.3-cp39-abi3-macosx_10_12_x86_64.whl (38.0 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file mineru_rs-0.2.3-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: mineru_rs-0.2.3-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 35.5 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for mineru_rs-0.2.3-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 7ba33041bb842217ee0bcc09c91a5fc877dbdb36cc88292c98eb6f271813e23b
MD5 5bb05e76999700320b78c163efc60c7c
BLAKE2b-256 aa1b61ffec3b4a48aebcf154165a025515dd67d60a045c35a01970d4f376d9b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for mineru_rs-0.2.3-cp39-abi3-win_amd64.whl:

Publisher: release.yml on agentsyaml/mineru-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 e1cd27fcf072038466c914240e9370fe5d1e3b4d255ecec8b59fb81e53000e9e
MD5 22b37d287d5c16113c0cc6eba0a176dc
BLAKE2b-256 ab71f8a53b5c6bb9f27adc37fda0f7ab1da3f22758967faf125bbc1773f13f52

See more details on using hashes here.

Provenance

The following attestation bundles were made for mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release.yml on agentsyaml/mineru-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 de6251135e6947a6c7cfb89110de317d80ac3991b4cf5046c227b0f3a4df0cf2
MD5 37bdb2b76fd8857bd166c525966ac360
BLAKE2b-256 e88d261f9b3da66a977c5b55f0d86cc10aa3cc30559f6443937b0f7036dc886a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mineru_rs-0.2.3-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: release.yml on agentsyaml/mineru-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mineru_rs-0.2.3-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for mineru_rs-0.2.3-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1933b4b4747df90736d9843b7d4c8a04c0dc2ec791cf8e944354cc1554273e0f
MD5 7a19e7afef0143ea8b9a9f241566c529
BLAKE2b-256 1e720a6dded5de359a907228d38af7c6b4f879b61464d252dfc6ed94c6d3b7b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for mineru_rs-0.2.3-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on agentsyaml/mineru-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mineru_rs-0.2.3-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for mineru_rs-0.2.3-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3071d65cc585e453c72d38cf27b9c05795f3114d8461c99001e2b9818861a2b4
MD5 1977a4ff699ecfabe4a20d5478cdb87f
BLAKE2b-256 e9ba5745fca97e5fdb33495dfe45a90c4fd73065830c1be366a7243162b1d189

See more details on using hashes here.

Provenance

The following attestation bundles were made for mineru_rs-0.2.3-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: release.yml on agentsyaml/mineru-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.0

5 files

0.2.9

5 files

0.2.8

5 files

0.2.7

5 files

0.2.6

5 files

0.2.5

5 files

0.2.4

5 files

This release

0.2.3 This release

5 files

0.2.2

5 files

0.2.1

5 files

0.2.0

5 files

0.1.1

5 files

0.1.0

5 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page