reviewdog /reviewdog
🐶 Automated code review tool integrated with any code analysis tools regardless of programming language
★ 9,742⑂ 517👁 60⑃ 2,617● 336▤ 47
-2
Daily
9,742
stars
517
forks
60
watchers
2,617
prs
336
issues
47
releases
README
reviewdog - A code review dog who keeps your codebase healthy.
reviewdog provides a way to post review comments to code hosting services,
such as GitHub, automatically by integrating with any linter tools with ease.
It uses an output of lint tools and posts them as a comment if findings are in
the diff of patches to review.
reviewdog also supports running in the local environment to filter the output of lint tools
by diff.
design doc
Table of Contents
- Installation
- Input Format
'errorformat'
Available pre-defined 'errorformat'
Reviewdog Diagnostic Format (RDFormat)
Diff
checkstyle format
SARIF format
- Code Suggestions
- reviewdog config file
- Reporters
[Reporter: Local (-reporter=local) [default]](reporter-local--reporterlocal-default)
Reporter: GitHub PR Checks (-reporter=github-pr-check)
Reporter: GitHub Checks (-reporter=github-check)
Reporter: GitHub PullRequest review comment (-reporter=github-pr-review)
Reporter: GitHub Annotations (-reporter=github-annotations)
Reporter: GitHub PR Annotations (-reporter=github-pr-annotations)
Reporter: GitLab MergeRequest discussions (-reporter=gitlab-mr-discussion)
Reporter: GitLab MergeRequest commit (-reporter=gitlab-mr-commit)
Reporter: Bitbucket Code Insights Reports (-reporter=bitbucket-code-report)
- Supported CI services
GitHub Actions
Travis CI
Circle CI
GitLab CI
Bitbucket Pipelines
Common (Jenkins, local, etc...)
+ Jenkins with GitHub pull request builder plugin
- Exit codes
- Filter mode
- Articles
!comment in pull-request
!commit status
!reviewdog-local-demo.gif
Installation
shell
Install the latest version. (Install it into ./bin/ by default).
$ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s
Specify installation directory ($(go env GOPATH)/bin/) and version.
$ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z]
In alpine linux (as it does not come with curl by default)
$ wget -O - -q https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s [vX.Y.Z]
Nightly releases
You can also use nightly reviewdog release
to try the latest reviewdog improvements every day!
shell
$ curl -sfL https://raw.githubusercontent.com/reviewdog/nightly/30fccfe9f47f7e6fd8b3c38aa0da11a6c9f04de7/install.sh | sh -s -- -b $(go env GOPATH)/bin
GitHub Action: reviewdog/action-setup
yaml
steps:
- uses: reviewdog/action-setup@d8edfce3dd5e1ec6978745e801f9c50b5ef80252 v1.4.0
with:
reviewdog_version: latest Optional. [latest,nightly,v.X.Y.Z]
homebrew / linuxbrew
You can also install reviewdog using brew:
shell
$ brew install --cask reviewdog/tTop issues
#196Looking for maintainers23 comments · 2019-03-07#856Better error handling behavoir (--fail-on-error)13 comments · 2021-01-17#581Set up gerrit integration test / demo12 comments · 2020-05-14#2079[Security Advisory] Supply Chain Attack on reviewdog GitHub Actions during a specific time period11 comments · 2025-03-18#1662Feature Request: Option to Disable the `"reported by reviewdog 🐶"` Prefix in Review Messages11 comments · 2024-02-07#924(*checkerGitHubClient).UpdateCheckRun posts invalid "annotations" field to GitHub API9 comments · 2021-04-14#354Feature request: introduce logger and verbose mode9 comments · 2019-11-08#1796Unable to install latest version of reviewdog v0.18.0 in my gitlab pipeline7 comments · 2024-06-21
Discussions
#2323Ability to remove `Raw output` from `github-pr-annotations`0 comments · 2025-11-12#2303Custom review rules?0 comments · 2025-10-14#2078So much noize from renovate/depup0 comments · 2025-03-18#1990Any chance to fork action-bundler-audit into an "official" reviewdog package?0 comments · 2024-12-24#1789How to commit without change0 comments · 2024-06-17#1745How to use reviewdog in monorepo? In other words, can I set working directory for runner?0 comments · 2024-05-13#1611Github Actions triggered by pushes are not detected as pull requests0 comments · 2023-11-14#1610Python library proof of concept0 comments · 2023-11-13
Latest release
v0.21.3 v0.21.3 2026-11-07See CHANGELOG Changelog c65f3f3c4152c5e0ed0adc67c017455a217709a3 Add CHANGELOG.md entry for 2823 195528004d05cb54fe7353271a3daa6f98523eba Allowing for Range.End to be Nil for gitlab_mr_discussion 25449d3df332fb06f0fc58119da3da189c6e7955 Lock GitHub Actions dependencies with gh actions-lock cd8e52fc8128b1a0e43ce21c19dade36f682c71e Merge branch 'master' into actions-lock 0cfcaaac222bcf73ede0c0ba8a2848044181ee77 Merge branch 'master' into actions-lock 7b547126b81acaff2b2392cbe9e93540e9e4c73e Merge branch 'master' into fix/doghouse-oauth-callback ae116dec058a2229c517055d760a12ea7c3a939f