mineru

name mineru description MinerU document extraction CLI that converts PDFs, images, and web pages into Markdown, HTML, LaTeX, or DOCX via the MinerU API. Supports token-free flash extraction for quick start, precision extraction with table/formula recognition, web crawling, batch processing, and piped workflows. read_when ["Extracting text from PDF documents","Converting documents to Markdown","Crawling web pages to Markdown","Batch document processing","OCR on scanned documents","Converting PDF to HTML, LaTeX, or DOCX","Parsing document content","Reading PDF files","Extracting tables from documents","Converting Word documents","Quick document parsing without login"] metadata {"openclaw":{"emoji":"📄","requires":{"bins":"[Truncated]"},"install":["[Truncated]","[Truncated]"]}} allowed-tools Bash(mineru-open-api:*) Document Extraction with mineru-open-api Installation npm install -g mineru-open-api Or via Go (macOS/Linux): go install github.com/opendatalab/MinerU-Ecosystem/cli/mineru-open-api@latest Verify installation mineru-open-api version Two extraction modes flash-extract extract Token required No Yes ( mineru-open-api auth ) Speed Fast Normal Table recognition No Yes Formula recognition No Yes OCR Yes Yes Output formats Markdown only md, html, latex, docx, json Batch mode No Yes Model selection pipeline Yes (vlm, pipeline, MinerU-HTML) File size limit 10 MB Much higher Page limit 20 pages Much higher Rate limit Per-IP per-minute cap Based on API plan Best for Quick start, small/simple docs Large docs, tables, production flash-extract limits Limit Value File size Max 10 MB Page count Max 20 pages Supported types PDF, Images (png/jpg/jpeg/jp2/webp/gif/bmp), Docx, PPTx IP rate limit Per-minute request caps (HTTP 429 when exceeded) When any limit is exceeded, the agent should suggest switching to extract with a token (create at https://mineru.net/apiManage/token ), which has significantly higher limits. Core workflow Start fast (no token): mineru-open-api flash-extract <file> for quick Markdown conversion Need more? Create token at https://mineru.net/apiManage/token , run mineru-open-api auth , then use mineru-open-api extract for tables, formulas, OCR, multi-format, and batch Web pages : mineru-open-api crawl <url> to convert web content Check results : output goes to stdout (default) or -o directory Authentication Only required for extract and crawl . Not needed for flash-extract . Configure your API token (create one at https://mineru.net/apiManage/token ): mineru-open-api auth # Interactive token setup export MINERU_TOKEN= "your-token" # Or set via environment variable Token resolution order: --token flag > MINERU_TOKEN env > ~/.mineru/config.yaml . Supported input formats Format flash-extract extract PDF ( .pdf ) Yes Yes Images ( .png , .jpg , .jpeg , .jp2 , .webp , .gif , .bmp ) Yes Yes Word ( .docx ) Yes Yes Word ( .doc ) No Yes PowerPoint ( .pptx ) Yes Yes PowerPoint ( .ppt ) No Yes HTML ( .html ) No Yes URLs (remote files) Yes Yes The crawl command accepts any HTTP/HTTPS URL and extracts web page content. Commands flash-extract — Quick extraction (no token needed) Fast, token-free document extraction. Outputs Markdown only. No table recognition. Limited to 10 MB / 20 pages per file, with IP-based rate limiting. mineru-open-api flash-extract report.pdf # Markdown to stdout mineru-open-api flash-extract report.pdf -o ./out/ # Save to file mineru-open-api flash-extract https://example.com/doc.pdf # URL mode mineru-open-api flash-extract report.pdf --language en # Specify language mineru-open-api flash-extract report.pdf --pages 1-10 # Page range flash-extract flags Flag Short Default Description --output -o (stdout) Output path (file or directory) --language ch Document language --pages (all) Page range, e.g. 1-10 --timeout 900 Timeout in seconds extract — Precision extraction (token required) Convert PDFs, images, and other documents to Markdown or other formats. Supports table/formula recognition, OCR, multiple output formats, and batch mode. mineru-open-api extract report.pdf # Markdown to stdout mineru-open-api extract report.pdf -f html # HTML to stdout mineru-open-api extract report.pdf -o ./out/ # Save to directory mineru-open-api extract report.pdf -o ./out/ -f md,docx # Multiple formats mineru-open-api extract *.pdf -o ./results/ # Batch extract mineru-open-api extract --list files.txt -o ./results/ # Batch from file list mineru-open-api extract https://example.com/doc.pdf # Extract from URL cat doc.pdf | mineru-open-api extract --stdin -o ./out/ # From stdin extract flags Flag Short Default Description --output -o (stdout) Output path (file or directory) --format -f md Output formats: md , json , html , latex , docx (comma-separated) --model (auto) Model: vlm , pipeline , html (see below) --ocr false Enable OCR for scanned documents --formula true Enable/disable formula recognition --table true Enable/disable table recognition --language ch Document language --pages (all) Page range, e.g. 1-10,15 --timeout 900 / 1800 Timeout in seconds (single/batch) --list Read input list from file (one path per line) | --concurrency | | 0 | Batch concurrency (0 = server default) | Model comparison: vlm vs pipeline vlm pipeline Parsing accuracy Higher — better at complex layouts, mixed content Standard Hallucination risk May produce hallucinated text in rare cases No hallucination — biggest advantage Best for Academic papers, complex tables, intricate layouts General documents where fidelity matters most When the user values accuracy and the document has complex formatting, suggest --model vlm . When the user prioritizes reliability and no-hallucination guarantee, suggest --model pipeline (or omit --model to use auto). crawl — Web page extraction (token required) Fetch web pages and convert to Markdown. mineru-open-api crawl https://example.com/article # Markdown to stdout mineru-open-api crawl https://example.com/article -f html # HTML to stdout mineru-open-api crawl https://example.com/article -o ./out/ # Save to file mineru-open-api crawl url1 url2 -o ./pages/ # Batch crawl mineru-open-api crawl --list urls.txt -o ./pages/ # Batch from file list crawl flags Flag Short Default Description --output -o (stdout) Output path --format -f md Output formats: md , json , html (comma-separated) --timeout 900 / 1800 Timeout in seconds (single/batch) --list Read URL list from file (one per line) --stdin-list false Read URL list from stdin --concurrency 0 Batch concurrency auth — Authentication management mineru-open-api auth # Interactive token setup mineru-open-api auth --verify # Verify current token is valid mineru-open-api auth --show # Show current token source and masked value Supported --language values The --language flag accepts the following values (default: ch ). Used by both flash-extract and extract . Values are organized by script/language family — each value covers all languages listed in its group. Standalone language packs For specific languages or CJK combinations. Value Included languages 说明 ch Chinese, English, Chinese Traditional 中英文（默认值） ch_server Chinese, English, Chinese Traditional, Japanese 繁体、手写体 en English 纯英文 japan Chinese, English, Chinese Traditional, Japanese 日文为主 korean Korean, English 韩文 chinese_cht Chinese, English, Chinese Traditional, Japanese 繁体中文为主 ta Tamil, English 泰米尔文 te Telugu, English 泰卢固文 ka Kannada 卡纳达文 el Greek, English 希腊文 th Thai, English 泰文 Language family packs One value covers many languages sharing the same script system. Value Script/Family Included languages latin Latin script (拉丁语系) French, German, Afrikaans, Italian, Spanish, Bosnian, Portuguese, Czech, Welsh, Danish, Estonian, Irish, Croatian, Uzbek, Hungarian, Serbian (Latin), Indonesian, Occitan, Icelandic, Lithuanian, Maori, Malay, Dutch, Norwegian, Polish, Slovak, Slovenian, Albanian, Swedish, Swahili, Tagalog, Turkish, Latin, Azerbaijani, Kurdish, Latvian, Maltese, Pali, Romanian, Vietnamese, Finnish, Basque, Galician, Luxembourgish, Romansh, Catalan, Quechua arabic Arabic script (阿拉伯语系) Arabic, Persian, Uyghur, Urdu, Pashto, Kurdish, Sindhi, Balochi, English cyrillic Cyrillic script (西里尔语系) Russian, Belarusian, Ukrainian, Serbian (Cyrillic), Bulgarian, Mongolian, Abkhazian, Adyghe, Kabardian, Avar, Dargin, Ingush, Chechen, Lak, Lezgin, Tabasaran, Kazakh, Kyrgyz, Tajik, Macedonian, Tatar, Chuvash, Bashkir, Malian, Moldovan, Udmurt, Komi, Ossetian, Buryat, Kalmyk, Tuvan, Sakha, Karakalpak, English east_slavic East Slavic (东斯拉夫语系) Russian, Belarusian, Ukrainian, English devanagari Devanagari script (天城文语系) Hindi, Marathi, Nepali, Bihari, Maithili, Angika, Bhojpuri, Magahi, Santali, Newari, Konkani, Sanskrit, Haryanvi, English Output behavior No -o flag : result goes to stdout; status/progress messages go to stderr With -o flag : result saved to file/directory; progress messages on stderr Batch mode ( extract / crawl only): requires -o to specify output directory Binary formats ( docx , extract only): cannot output to stdout, must use -o Markdown output includes extracted images saved alongside the .md file General rules When using this skill on behalf of the user: Quote file paths that contain spaces or special characters with double quotes in commands. Example: mineru-open-api extract "report 01.pdf" , NOT mineru-open-api extract report 01.pdf . Don't run commands blindly on errors — if the user asks "提取失败了怎么办", explain the exit code and troubleshooting steps instead of re-running the command. Installation questions ("mineru 怎么安装") should be answered with the install instructions, not by running mineru-open-api extract . DOCX as input is supported — if the user asks "这个 Word 文档能转 Markdown 吗", use mineru-open-api extract file.docx or mineru-open-api flash-extract file.docx . Note: .doc format is only supported by extract , not flash-extract . Table extraction — tables are only recognized by extract (not flash-extract ). If the user mentions tables, use extract .