The Python command behind cpp-linter-action: it runs clang-format and clang-tidy on C and C++ files, locally or in other CI.
Website · Documentation · Get started · Discussions
Note
This is cpp-linter v1, which gets bug fixes only. New features go to v2, a rewrite in Rust that lives in the cpp-linter-rs repository and is in release candidate stage.
v2 keeps the cpp-linter name on PyPI, so pip install --upgrade cpp-linter will install
v2 once 2.0 is released. To stay on v1, pin cpp-linter<2. The
migration guide lists what changes.
With the clang tools installed (see Limitations):
pip install "cpp-linter<2" cpp-linter --version=21 --style=file --tidy-checks=''
For usage in a GitHub Actions workflow, see the cpp-linter/cpp-linter-action repository
For the description of supported Command Line Interface options, see the CLI documentation
Passing the --fix option makes cpp-linter apply clang-format fixes in-place to
any files that have formatting problems.
Note
--fix only applies clang-format fixes. clang-tidy fixes are not applied
automatically.
- cpp-linter does not install the clang tools. Install them first, for example with
clang-tools; without them,
--version=21falls back to whateverclang-formatandclang-tidyare on yourPATH. - It exits 0 even when checks fail, so it reports findings but does not fail a build.
--files-changed-onlyand--lines-changed-onlyread the local git diff, except in GitHub Actions (and Gitea Actions), where those options ask the server's REST API for the changed files.
cpp-linter is maintained by two volunteers. Sponsor the project through Open Collective. Silver and Gold sponsors get their logo here.
To provide feedback (requesting a feature or reporting a bug) please post to issues. To contribute changes, see CONTRIBUTING.rst.
The scripts and documentation in this project are released under the MIT License.