Run local analysis before creating a commit

 

Setup 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 project, 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> --codacy-api-base-url <API-BASE-URL>

If you don't specify the tool, the analysis will run as Codacy does in the backend. For specific results, you can pass it with --tool.

You can see the available tools with:
codacy-analysis-cli analyse --help

Enterprise

There is an additional step to go through if you are using Codacy Enterprise.
Please configure the endpoint where Codacy enterprise is running either by using the flag--codacy-api-base-url or the environment variable CODACY_API_BASE_URL

Docs

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 FindBugs
--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

Ignored Issues

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

When uploading results in Enterprise the ignores will be reflected on Codacy after the analysis finishes.

Disclaimer:

Please keep in mind the CLI is still in ongoing development and the APIs it uses might be broken without notice.

The pushing results feature, enabled by the `--upload` flag, is only available for enterprise installations.

 

If you run into issues or have any questions, please don't hesitate to reach out at support@codacy.com.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.