rust-llm-tidy-cli

Command-line interface for rust-llm-tidy-reorder.

Installation

cargo install rust-llm-tidy-cli

Or build from source:

cargo build --release -p rust-llm-tidy-cli

Usage

rust-llm-tidy is a single command that runs the full pipeline (fix, reorder, vis, lints) by default on .rs and .md files:

# Tidy a file in place
rust-llm-tidy src/main.rs

# Preview changes without modifying the file
rust-llm-tidy --dry-run src/main.rs

# Tidy every .rs/.md file under a directory recursively
rust-llm-tidy src

# No paths given -> process the changed files in the current git diff
rust-llm-tidy

# Run only specific ops (repeatable); overrides the config `include` mode
rust-llm-tidy --include vis src/lib.rs
rust-llm-tidy --include reorder --include vis src

# Skip an op for this run (additive to config `exclude`)
rust-llm-tidy --exclude lints src

# Validate the config without processing files
rust-llm-tidy --validate

Flags

Operations

An optional YAML config file (.rust-llm-tidy.yml) may exclude files from processing, whitelist or blacklist specific rules per path, and run external programs (e.g. rustfmt) on every processed file. Pass --config <PATH> to use an explicit config or --no-config to disable discovery. See the repository README for the full schema.

Ordering Rules

The algorithm orders top-level items across phases. Within most phases, an item comes before any item it references; alphabetical order breaks ties. See docs/reorder.md for an annotated 10-phase example.

License

Licensed under Apache 2.0