Usage Guide

This section provides comprehensive usage instructions for the project. We will help you progressively master the project's usage from basic to advanced through the following sections:

Table of Contents

• Tiers and runtimes
• Python SDK
• V1 HTTP API
• 3.x → 4.0 migration

• Legacy platforms (MinerU <4)

• Quick Usage - Quick setup and basic usage

• Model Source Configuration - Detailed configuration instructions for model sources
• Command Line Tools - Detailed parameter descriptions for command line tools
• Advanced Optimization Parameters - Advanced parameter descriptions for command line tool adaptation

Getting Started

mineru is the document-library CLI for interactive and agent workflows. Use mineru-kit for stateless batch parsing, the V1 API server, Gradio, model management, and multi-service routing.

We recommend reading the documentation in the order listed above, which will help you better understand and use the project features.

If you encounter issues during usage, please check the FAQ