Skip to main content

Documentation Index

Fetch the complete documentation index at: https://imcui.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Quick Start

Get up and running with Image Matching WebUI in minutes. This guide covers the fastest way to start matching images.
Need other installation methods? See the installation guide for Docker, source installation, and more.

1. Install (PyPI)

The fastest way to install Image Matching WebUI:
pip install imcui
Or with dataset support:
pip install imcui[datasets]

2. Launch

Start the web interface:
imcui -s 127.0.0.1
This opens http://localhost:7860 in your browser.

3. Match Images

The interface provides four simple steps:

1. Upload

Select two images you want to match

2. Choose Algorithm

Pick from 20+ matching algorithms

3. Configure

Adjust thresholds and parameters

4. Match

Click “Match” and view results

What’s Next?

Now that you’re running, explore these resources:

Compare Algorithms

Test different algorithms on your images

Custom Configuration

Tune parameters for your use case

Use the API

Automate matching programmatically

Troubleshoot Issues

Get help with common problems

Try Without Installation

Not ready to install? Try the demo first:

Try HuggingFace Demo

Test the interface without installation