Skip to content
This documentation applies to Codacy Self-hosted v5.1.0

For the latest updates and improvements, see the latest Cloud documentation instead.

Client-side tools#

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:

  • 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 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.

  • 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.

Running the client-side tools#

Tip

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:

See also#

See the full list of supported languages and tools to check the programming languages that the client-side tools 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?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

If you have a question or need help please contact support@codacy.com.

Last modified November 8, 2021