For the latest updates and improvements, see the latest Cloud documentation instead.
Getting started with Codacy¶
Codacy automatically identifies issues through static code review analysis and notifies you on security issues, code coverage, code duplication, and code complexity in every commit and pull request.
To get started, head to codacy.com and click Get started.
1. Sign up¶
Signing up with a Git provider such as GitHub, GitLab, or Bitbucket links your Codacy user with your Git provider user, making it easier to add repositories to Codacy and invite your teammates.
Codacy will ask you to have access to your Git provider during the authorization flow. Check the permissions that Codacy requires and why. Codacy will also ask you to fill in a few details about your company so we know a bit more about your use case.
2. Choose an organization¶
Now, you'll need to join one or more organizations that contain your repositories. The organization with the same name as your Git provider username contains your personal repositories. The selected organizations will then be synced with Codacy so that managing your team permissions is easy. Read more about what synced organizations do.
Tip
If you can't see the organization you are looking for, follow these troubleshooting instructions.
To start adding your repositories, select one of the organizations and click Go to add repositories.
3. Add repositories¶
As a final step, add the repositories that you wish to analyze. Codacy will start the first analysis and set up everything required to ensure your next commits on those repositories are analyzed.
Tip
You can only add repositories on Codacy if you have the necessary permissions on your Git provider.
Codacy begins an initial analysis as soon as you add a repository, and displays an overview of the code quality of your repository when the analysis is complete.
4. Tweak your repository settings¶
Check the static analysis results on the Issues page to explore the initial analysis results.
The first analysis is based on Codacy default configurations, so you should tweak and adapt the following configurations to match your preferences and specific scenario:
- Ignore files that you want to exclude from the Codacy analysis
- Configure the code patterns that Codacy uses to analyze your repository
- Configure your quality settings for pull requests
You're all set! 🎉¶
Congratulations, your new repository is ready!
Optionally, you can also:
- Add a Codacy badge to your repository displaying the current code quality grade or code coverage
- Add coverage reports to Codacy.
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.