explaingit

leecoursey/mineru-gui

Analysis updated 2026-05-18

0PythonAudience · developerComplexity · 3/5LicenseSetup · hard

TLDR

A local web interface for processing one document at a time through the MinerU document conversion tool, with live progress and job history.

Mindmap

mindmap
  root((MinerU GUI))
    What it does
      One document at a time
      Live command output
      Job history tracking
    Tech stack
      Python
      Docker Compose
      MinerU backend
    Use cases
      Archival scan conversion
      Searchable output files
      GPU accelerated runs
    Audience
      Developers with MinerU
    Notes
      Requires MinerU installed
      Local only no auth

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Run a single document through MinerU with a visible, step by step interface.

USE CASE 2

Convert archival scans of older documents into searchable markdown output.

USE CASE 3

Track job history and download generated files from completed conversions.

USE CASE 4

Process documents with optional GPU acceleration on Windows or Linux.

What is it built with?

PythonDockerDocker ComposeMinerU

How does it compare?

leecoursey/mineru-gui0xallam/my-recipe0xhassaan/nn-from-scratch
Stars00
LanguagePythonPythonPython
Last pushed2022-11-22
MaintenanceDormant
Setup difficultyhardmoderatemoderate
Complexity3/52/54/5
Audiencedevelopergeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · hard Time to first run · 1h+

Requires Docker Compose plus a separately installed MinerU container image before the GUI can run anything.

The GUI source is free to use for any purpose, including commercial use, as long as you keep the required attribution notices.

In plain English

MinerU Archival GUI is a locally hosted web interface built on top of MinerU, a document processing tool. Instead of handling large batches of files, this GUI is built for a different job: taking one document at a time, checking its page count, running MinerU on it, watching the command output live, and reviewing the results afterward. It grew out of a personal need to make occasional archival scans of older industry references searchable and easier to reuse, so it favors a clear, visible workflow over automation at scale. The interface supports drag and drop uploads, automatic page range detection, controls for MinerU's backend and processing options, a live output log, and a history of recent jobs. Generated files appear in a compact file tree with direct downloads, and completed jobs can automatically clean up temporary working copies while keeping the final markdown, images, and content files. It also includes both a light mode and a dark mode. This project only provides the GUI layer. It does not include MinerU itself or its models, so you need Docker with Compose support and a working MinerU container image already set up separately, following MinerU's own installation instructions. It is designed to run on Windows with Docker Desktop or WSL2, or on Linux with Docker Engine, and optionally supports NVIDIA GPU acceleration through the NVIDIA Container Toolkit. macOS is not currently tested or supported. Once MinerU is installed, starting the app is a matter of running a provided script for your platform, which launches the service on localhost only, since the app has no built in authentication. All processed documents and job data stay in a local data folder that is excluded from version control. The project describes itself as an early, experimental release extracted from a working personal setup, and the GUI source code is released under the Apache License 2.0, separate from MinerU's own licensing terms.

Copy-paste prompts

Prompt 1
Help me install MinerU and get MinerU Archival GUI running with Docker Compose.
Prompt 2
Explain what happens to my data in the data/uploads and data/outputs folders.
Prompt 3
Walk me through enabling GPU mode for MinerU on Linux.
Prompt 4
Show me how to troubleshoot MinerU Archival GUI when the mineru:latest image is not found.

Frequently asked questions

What is mineru-gui?

A local web interface for processing one document at a time through the MinerU document conversion tool, with live progress and job history.

What language is mineru-gui written in?

Mainly Python. The stack also includes Python, Docker, Docker Compose.

What license does mineru-gui use?

The GUI source is free to use for any purpose, including commercial use, as long as you keep the required attribution notices.

How hard is mineru-gui to set up?

Setup difficulty is rated hard, with roughly 1h+ to a first successful run.

Who is mineru-gui for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.