Convert HTML files or web page URLs to clean Markdown using MinerU. Removes navigation, ads, and clutter — keeps the readable content.

Install

npm install -g mineru-open-api
# or via Go (macOS/Linux):
go install github.com/opendatalab/MinerU-Ecosystem/cli/mineru-open-api@latest

Quick Start

# Convert a web page URL to Markdown (requires token)
mineru-open-api crawl https://example.com/article -o ./out/
# Convert a local HTML file to Markdown (requires token)
mineru-open-api extract page.html -o ./out/
# Output to stdout (requires token)
mineru-open-api crawl https://example.com/article

Authentication

Token required:

mineru-open-api auth             # Interactive token setup
export MINERU_TOKEN="your-token" # Or via environment variable

Create token at: https://mineru.net/apiManage/token

Capabilities

• Input: remote web page URL or local .html file
• Output: Markdown
• For remote URLs: use crawl (token required)
• For local HTML files: use extract (token required)
• HTML is NOT supported by flash-extract

Notes

• Always requires token (no flash-extract support for HTML)
• Output goes to stdout by default; use -o to save to a file or directory
• All progress/status messages go to stderr; document content goes to stdout
• MinerU is open-source by OpenDataLab (Shanghai AI Lab): https://github.com/opendatalab/MinerU