panache-lint(1)

NAME
panache-lint - Lint a Quarto, Pandoc, or Markdown document

SYNOPSIS
panache lint [--check] [--fix] [--message-format] [--force-exclude] [-h|--help] [FILES]

DESCRIPTION
Lint a document to check for correctness issues and best practice violations. Unlike the formatter which handles style, the linter catches semantic problems like syntax errors, heading hierarchy issues, and broken references.

OPTIONS

--check
    Exit with code 1 if violations found (CI mode)

--fix
    Automatically fix violations where possible

--message-format <MESSAGE_FORMAT> [default: human]
    Diagnostic rendering format
    Possible values:

    •   human

    •   short

--force-exclude
    Apply exclude patterns to explicitly provided files

-h, --help
    Print help (see a summary with '-h')

[FILES]
    Path(s) to the input file(s) or directories to check. If not provided, reads from stdin. Supports .qmd, .md, .Rmd/.Rmarkdown, and other Markdown-based formats. Supports glob patterns (e.g., *.md) and directories (e.g., . or docs/). Directories are traversed recursively, respecting .gitignore files.

EXTRA
Configure rules in panache.toml with [lint] section.