Skip to content
janitor-sh logo janitor-sh logo janitor-sh Docs

Installation

Section titled “Recommended: install from PyPI with uv”
Terminal window
uv tool install janitor-sh

Verify installation:

Terminal window
janitor --help

Prerequisites

Section titled “Prerequisites”
  • uv installed on your machine
  • A repository that contains code or documentation files janitor can process

Source build fallback

Section titled “Source build fallback”

Use this if you are testing local source changes or cannot use PyPI.

  1. Build from a local checkout:
Terminal window
cargo build --release
  1. Run the binary directly:
Terminal window
./target/release/janitor --help
  1. Optional install from local source:
Terminal window
uv tool install . --force

Next step

Section titled “Next step”

Continue with Getting Started to run janitor safely in local repositories.