Run local analysis¶

Set up the Codacy Analysis CLI¶

Follow the installation guide to get the codacy-analysis-cli executable running on your build server.

Running an analysis with the CLI¶

At the moment, the CLI still requires to retrieve the configuration from Codacy to perform an analysis. In order to access the repository, you will have to obtain a Project Token as explained in the CLI documentation. Then, you can invoke the CLI to get a report with all the issues:

codacy-analysis-cli analyse --directory <SOURCE-CODE-PATH> \
                            --project-token <PROJECT-TOKEN> \
                            --allow-network \
                            --codacy-api-base-url <API-BASE-URL> \
                            --verbose \
                            --upload

If you don't specify the tool, the analysis will run as Codacy does in the backend. To obtain results for a particular tool, specify the tool with --tool.

You can see the available tools with:

codacy-analysis-cli analyse --help

Codacy Self-hosted¶

If you are using Codacy Self-hosted, you must configure the endpoint where Codacy Self-hosted is running either by using the flag --codacy-api-base-url or the environment variable CODACY_API_BASE_URL.

Advanced configuration¶

For advanced configuration details, check all the CLI flags in the CLI documentation.

Some flags you might be interested in:

--allow-network - to run the tools that require compilation like SpotBugs, FindBugs, FindSecBugs
--max-allowed-issues - returns a non-zero exit code when a certain number of issues is exceeded
--fail-if-incomplete - to return a non-zero exit code when any tool fails to run successfully

Notes on ignored issues¶

If you have ignored issues on Codacy be aware that the CLI will not respect those ignored issues when printing the results locally.

When uploading results for Codacy Self-hosted the ignored issues will be reflected on Codacy after the analysis is complete.

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.

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

Last modified August 7, 2020