janitor-sh 0.1.0

Automated code formatting and linting for GitHub and GitLab.

janitor-sh CLI 🧹

The core Rust-based engine for the janitor-sh organization. This CLI provides high-performance, automated code formatting and linting orchestration across local and CI/CD environments.

[!IMPORTANT] This repository is private and contains the core logic for the janitor-sh automation engine.

Features

• Multi-Platform Detection: Automatically identifies if it's running in GitHub Actions, GitLab CI, or a local terminal.
• Smart Orchestration: Invokes industry-standard tools based on the project structure:
  • Ruff: For lightning-fast Python linting and formatting.
  • Biome: For high-performance JavaScript/TypeScript orchestration.
  • rumdl: For consistent formatting of Markdown and documentation files.
  • Clippy & Cargo Fmt: For maintaining Rust code quality.
• Automated Fixes: Designed to automatically apply and commit fixes to minimize developer overhead.

Installation

Prerequisites

• Rust (2024 edition)
• rumdl (for Markdown formatting)
• uv (for package management and tool installation)

Local Setup

1. Clone the repository:

   git clone https://github.com/janitor-sh/cli.git
   cd cli
   

2. Build and Install: You can use the provided installation script:

   bash install.sh
   

   Alternatively, build with cargo:

   cargo build --release
   

[!NOTE] To install as a global tool using uv, run:

uv tool install .

Usage

Run the janitor CLI from the root of any supported repository:

janitor

The tool will automatically detect your environment and run the appropriate suite of formatters and linters.

Commit Mode Flags

• --auto-commit: force creation of an automated conventional commit when janitor applies fixes.
• --no-commit: force janitor to skip commit creation.
• default behavior:
  • in CI (GitHub Actions and GitLab CI): auto-commit enabled.
  • local runs: no auto-commit.

You can also scope execution to a single tool:

janitor --tool ruff

Development

Running Tests

We maintain high standards for correctness and platform compatibility.

cargo test

Linting & Formatting

Ensure your contributions follow our style guidelines:

cargo clippy -- -D warnings
cargo fmt -- --check

Contributing

Please read the internal guidelines in the .github-private repository before contributing.

Release Runbook

One-time repository setup:

• Create GitHub environment pypi (recommended: protect with tag-only deploy rules).
• Configure a PyPI Trusted Publisher for this repository/workflow/environment.
• Set Cloudflare deployment settings:
  • secret: CLOUDFLARE_API_TOKEN
  • secret: CLOUDFLARE_ACCOUNT_ID
  • variable: CLOUDFLARE_PAGES_PROJECT

1. Update version in /Users/drew.simmons/developer/github/personal/janitor-sh/cli/pyproject.toml.
2. Update /Users/drew.simmons/developer/github/personal/janitor-sh/cli/CHANGELOG.md.
3. Update /Users/drew.simmons/developer/github/personal/janitor-sh/cli/docs/src/pages/docs/release-notes.md.
4. Merge to main and create a GitHub Release tag in the form vX.Y.Z.
5. Monitor these workflows:
   • /Users/drew.simmons/developer/github/personal/janitor-sh/.github/workflows/cli-release.yml
   • /Users/drew.simmons/developer/github/personal/janitor-sh/.github/workflows/cli-docs-pages.yml
6. Verify successful publication on PyPI and docs deployment on Cloudflare Pages.

---

© 2026 janitor-sh. All rights reserved.