Installation¶

ruff-sync is a Python CLI tool. We recommend using uv for the best experience—it's fast, reliable, and allows you to run tools without managing global environments.

⚡ Recommended: Using `uv`¶

Persistent Tool Installation¶

The easiest way to use ruff-sync across all your projects is by installing it as a uv tool:

uv tool install ruff-sync
# Then simply run:
ruff-sync

One-off Invocation¶

If you just want to run ruff-sync once without installing it, use uvx:

uvx ruff-sync

Project-specific Development¶

To keep the version consistent across your team and locked to your project, add it to your development dependencies:

uv add --dev ruff-sync
# Then run it with:
uv run ruff-sync

🛠️ Other Installation Methods¶

pipxpip

pipx is the recommended way to install Python CLIs globally in isolated environments.

pipx install ruff-sync

You can install ruff-sync from PyPI using pip:

pip install ruff-sync

[!WARNING] We recommend using a virtual environment or pipx to avoid dependency conflicts with other global packages.

Verifying Installation¶

Check that ruff-sync is installed correctly by running:

ruff-sync --version