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

Getting Started

Quick start

Section titled “Quick start”

  1. Run janitor from the root of your repository.

    Terminal window
    janitor

  2. For local safety-first runs, explicitly disable commit creation.

    Terminal window
    janitor --no-commit

  3. Scope to a single tool when needed.

    Terminal window
    janitor --tool ruff

Commit behavior

Section titled “Commit behavior”

Default behavior depends on platform detection:

  • GitHub Actions and GitLab CI: auto-commit is enabled by default.
  • Local terminal runs: auto-commit is disabled by default.

Override this behavior with flags:

  • --auto-commit: force auto-commit.
  • --no-commit: force no commit.

--auto-commit and --no-commit cannot be used together.

Tool filter values

Section titled “Tool filter values”

Current supported values for --tool:

  • ruff
  • biome
  • clippy
  • cargo-fmt
  • rumdl

Common command patterns

Section titled “Common command patterns”
Terminal window
# Default run (platform-aware commit behavior)
janitor


# Local run with no commit
janitor --no-commit


# Force auto commit in local testing
janitor --auto-commit


# Run only Biome
janitor --tool biome