Getting Started

Start with Installation if Badness is not yet available on your PATH.

This page walks through formatting and linting your first file from the command line. For editor integration, see Editor Setup.

Formatting a File

Format a file in place:

badness format paper.tex

See Formatting for multiple files and standard input.

Verify formatting without writing, for example in CI:

badness format --check paper.tex

The command prints a diff and exits with a nonzero status if any file needs formatting. See Checking Without Writing for reporting options.

Report problems in your source:

badness lint paper.tex

The command exits with a nonzero status when it reports a diagnostic. See Linting for rules, fixes, and output formats.

See Style Options for command-line overrides and Configuration for shared project settings. Continue with Integrations to automate the checks.