Installation

ruff-sync is a Python CLI tool. We recommend using uv for the best experience, but it works with standard Python package managers as well.

Recommended: Using uv

If you are using uv, you can run ruff-sync without installing it globally:

uvx ruff-sync pull

Or add it to your project's development dependencies:

uv add --dev ruff-sync
uv run ruff-sync pull

Other 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