Docs

Unfix 0.1 quickstart

Requirements

• OS: Windows 10/11 or Linux.
• Docker: Docker Desktop/Engine running Linux containers.
• Git.
• uv.
• Disk: at least 5 GiB free (10 GiB recommended).
• Memory: at least 0.5 GiB free RAM and a 2 GiB Docker/WSL memory limit. For TSan or larger builds, aim for 2 GiB free RAM and a 6 GiB Docker/WSL limit.

These are unfix doctor thresholds, not a guarantee for every project. The first install and image build need internet access for Python packages and Docker packages.

Install

Use the wheel sent to you; no access to our GitHub repository is needed. Don't have it yet? Get the beta. In a terminal in the directory containing the wheel:

uv tool install --python 3.12 --compile-bytecode ./unfix-<version>-py3-none-any.whl

uv downloads Python 3.12 if it is not installed. Keep --python 3.12: uv tool installation otherwise chooses a default interpreter even when the wheel declares a narrower Python range. On Windows, replace ./ with .\ if using PowerShell. In the command above, <version> stands for the version in the filename you received; use the exact filename.

Check with unfix doctor

unfix --version
unfix doctor

doctor reports Docker, disk, memory, the C/C++ image, TSan, dependency network, and a connected board when configured. Follow each Fix: line before continuing.

Run the demo

unfix demo
cd unfix-demo
unfix

In the UI, run /bug to reproduce the bundled memory bug. Run /fix patches/masking.diff to see REJECTED because the patch disables AddressSanitizer. Then run /fix patches/honest.diff to see VERIFIED. The first run builds the Docker image and can take longer than the rest of the demo. Run /report to export the local HTML report. Type /help for commands.

Use your project

From a Git checkout of your C/C++ project, run unfix. Review the detected build/test commands and confirm creation of unfix.yaml. Existing cplus.yaml files continue to work; keep only one of the two names. Use /bug to choose a failing test, provide a failing command or paste a log. Once it says REPRODUCED, use /fix with your working tree, a branch, commit, or patch. Commit unfix.yaml before using an agent. See agent setup for Claude Code and Codex MCP instructions.

If you get stuck, email hello@unfix.dev with the output of unfix doctor, the verification ID, and the exported HTML report. Source files are not needed. Review the report before sending it because it may include project relative paths and selected failure output.