checkstyle-cli#

A command-line tool for checkstyle.

Quickstart#

Installation#

To install checkstyle-cli, run this command.

$ pip install checkstyle-cli

If you want checkstyle-cli to be used for pre-commit, Add this to your .pre-commit-config.yaml.

repos:
  - repo: https://github.com/junghoon-vans/checkstyle-cli
    rev: v0.7.1 # Use the ref you want
    hooks:
    - id: checkstyle

Usage#

$ checkstyle [options] [files...]

# run on current path with default options
$ checkstyle .

# run with custom options
$ checkstyle -c custom_config.xml --runtime-version 10.9.2 path/to/project

User Guide#

API documentation#

Changelog#

Indices and tables#