Configure scanning with .aikido files

The .aikido file lets you fine-tune how Aikido handles a specific repository. Aikido reads it automatically for every scan.

Default behavior and customization

Aikido already excludes many irrelevant files and directories by default. In most repositories, you do not need extra configuration.

Use .aikido when you need repository-specific exceptions or behavior. Common use cases include excluding specific paths, ignoring accepted CVEs with a reason, and giving custom context for AutoFix behavior for that repository.

Setting up the .aikido file

Create the .aikido file within the root of your repository.

Project directory with .aikido config file.

Exclude specific paths or files

The exclude key and paths subkey allow you to hide specific files and directories from being scanned by Aikido code scanning. This will automatically exclude scans for secrets, SAST issues, lockfiles and code quality.

Note: Path matching in .aikido is based on simple string inclusion.

If a configured value appears anywhere in the full file path, it will be excluded. Wildcards and regular expressions are not supported.

Ignore CVEs

To ignore CVE's, add them to the .aikido yaml file with a reason. The Aikido UI will also show that these specific CVEs are ignored with reference to the .aikido file.

High severity CVE downgraded via .aikido config file.

Ignore Alternatives

Ignore SAST via code comments

It's also possible to ignore SAST findings using comments within your code.

Other .aikido use cases

The .aikido file can also configure repository-specific AutoFix behavior.

Use this to define settings like a custom branch prefix or a single AutoFix PR for the whole repository.

See AutoFix PR Configuration for the supported autofix settings and examples.