◐ Shell
reader mode source ↗
Ctrlk
Ask
Changelog NotificationsAPIAikido login
For the complete documentation index, see llms.txt. This page is also available as Markdown.
Ask
On this page

Code Quality Setup

PR checks focus on new code — the lines you add or change in a pull request. Aikido scans those changes automatically and leaves inline comments (or fails the gate) so quality issues don't make it into your main branch.

This guide walks you through setting up Code Quality in your PR / MR Checks. To scan existing code across a full repository — category scores, open findings, and hotspots — see Repository Scans.

Prerequisites

Before you begin, ensure you have:

Code Quality isn't available for Local Scanning Accounts or Team Foundation Version Control (TFVC) repositories.

Getting started

There are 3 steps in total to setup and run your first code quality steps. The Aikido UI shows clearly which steps to follow on the Code Quality page (accessible from sidebar). Below is a more extensive description.

1

Enable Code Quality for repositories

Choose which repositories should have Code Quality checks enabled:

  1. Click Configure Repositories on the Code Quality Page to open the PR checks page. If you haven't configured the CI checks yet, you will be taken through the installation flow.

  2. Select the repositories where you want to run code quality checks and enable the Code Quality functionality (on the bottom) in the modal. You can choose whether you just want to add comments or also fail the gate.

2

Select quality checks

Configure which code quality rules to enforce on the Code Quality Checks page

  1. Browse through the available checks organized by:

    • Default checks - Pre-configured best practices for multiple languages

    • Custom checks - Rules specific to your team (you can add these later)

  2. Toggle checks on/off based on your team’s needs

3

Run your first scan

Once you’ve configured repositories and checks:

  1. Create a new pull request, or push a new commit to an existing pull request in one of the configured repositories. This will automatically trigger your first Code Quality scan.

  2. Review the results in the Activity tab.

Last updated

Was this helpful?