Running aligncheck¶

To run aligncheck as a client-side tool:

Enable Run analysis through build server in your repository Settings, tab General, Repository analysis.

This setting enables Codacy to wait for the results of the local analysis before resuming the analysis of your commits.
Obtain a project API token for your repository.

You need the project API token to allow the Codacy Analysis CLI to authenticate to Codacy when reporting the analysis results.
Set the following environment variable to specify your project API token:
```
export CODACY_PROJECT_TOKEN=<your project API token>
```
Warning

Never write API tokens on your configuration files and keep your API tokens well protected, as they grant owner permissions to your projects on Codacy.

We recommend that you set API tokens as environment variables. Check the documentation of your CI/CD platform on how to do this.
If you're using Codacy Self-hosted set the following environment variable to specify your Codacy instance URL:
```
export CODACY_API_BASE_URL=<your Codacy instance URL>
```

Download and run the Codacy Analysis CLI on the root of the repository, specifying the tool aligncheck.

codacy-analysis-cli analyze --tool aligncheck \
                            --allow-network \
                            --upload \
                            --verbose

The Codacy Analysis CLI runs aligncheck on your repository and uploads the results to Codacy so you can use them in your workflow.

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 March 26, 2021