Installation

Requirements

Qontinui is a Python library for model-based GUI automation with intelligent state management and visual recognition. Before installing, make sure your environment meets these requirements:

The recommended way to install Qontinui is from PyPI using pip. This installs the qontinui package along with all of its runtime dependencies.

pip install qontinui

python -m venv .venv
# macOS / Linux
source .venv/bin/activate
# Windows (PowerShell)
.venv\Scripts\Activate.ps1

pip install qontinui

For development, or to track the latest changes, install from the GitHub repository. Qontinui uses Poetry to manage dependencies.

git clone https://github.com/qontinui/qontinui.git
cd qontinui

# Install with Poetry (recommended for development)
poetry install

# Or with pip in editable mode
pip install -e .

Optional Extras

Qontinui defines a few optional dependency groups (extras) for advanced features. Enable them with Poetry when you need them:

# UI-TARS quantization support (local inference on consumer GPUs)
poetry install -E uitars

# Local embeddings via sentence-transformers
poetry install -E embeddings

# PaddleOCR as an alternative OCR engine for OmniParser
poetry install -E omniparser

Verify the Installation

Confirm Qontinui imports correctly and check the installed version:

python -c "import qontinui; print(qontinui.__version__)"

A successful install also exposes the qontinui command-line entry point:

qontinui --help