Client-side tools enable you to run analysis either locally or as part of your CI pipeline, and then integrating the results into Codacy. 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:
Containerized tools: 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.
Standalone tools: Codacy provides auxiliary converters that parse the output of third-party tools and convert to a format that you then upload to Codacy. 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.
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 each client-side tool can analyze.
Share your feedback 📢
Did this page help you?
Thanks for the feedback! Is there anything else you'd like to tell us about this page?
255 characters left
We're sorry to hear that. Please let us know what we can improve:
255 characters left
Alternatively, you can create a more detailed issue on our GitHub repository.
Thanks for helping improve the Codacy documentation.
Edit this page on GitHub if you notice something wrong or missing.
If you have a question or need help please contact firstname.lastname@example.org.