Client-side tools enable you to run analysis either locally or as part of your CI process and integrating the results into your Codacy workflow. This way, Codacy presents the analysis information reported by your local tools alongside all other code quality information on the Codacy dashboards.
Codacy supports client-side tools in two ways:
Codacy provides auxiliary converters that parse the output of third-party tools and convert to a format that you then upload to Codacy using the API. You must download, configure, and run the third-party tools yourself.
You can't configure these tools on the Codacy UI, since you manage their configuration locally.
Codacy provides a Docker image for the tools, and you run the images using the Codacy Analysis CLI.
The Codacy Analysis CLI automatically fetches the code pattern settings that you define on the Codacy UI and applies them when running these tools.
Running the client-side tools#
If you're using GitHub we recommend that you use the Codacy Analysis CLI GitHub Action to run the client-side tools and upload the results to Codacy.
Follow the instructions on how to run the supported client-side tools:
- aligncheck (Containerized)
- Clang-Tidy (Standalone)
- deadcode (Containerized)
- Faux Pas (Standalone)
- Gosec (Standalone)
- SpotBugs (Containerized)
- Staticcheck (Standalone)
See the full list of supported languages and tools to check the programming languages that the client-side tools can analyze.
Share your feedback 📢
Let us know if this page was helpful:
Thank you for the feedback!
We're sorry to hear that. Please let us know what we can improve.