コンテンツにスキップ

.aikido ファイルによるスキャン設定

.aikido ファイルを使用すると、特定のリポジトリでの Aikido の動作を細かく調整できます。Aikido はスキャンのたびにこのファイルを自動的に読み込みます。

デフォルトの動作とカスタマイズ

Section titled “デフォルトの動作とカスタマイズ”

Aikido はデフォルトで、関連性のない多くのファイルやディレクトリを既に除外しています。ほとんどのリポジトリでは追加の設定は不要です。

リポジトリ固有の例外や動作が必要な場合に .aikido を使用してください。よくあるユースケースとして、特定のパスの除外、理由を付けたCVEの無視、そのリポジトリ向けのAutoFix動作へのカスタムコンテキストの付与などがあります。

.aikido ファイルのセットアップ

Section titled “.aikido ファイルのセットアップ ”

.aikido ファイルをリポジトリのルート内に作成してください。

.aikido 設定ファイルが置かれたプロジェクトディレクトリ

特定のパスやファイルを除外する

Section titled “特定のパスやファイルを除外する ”

exclude キーと paths サブキーを使うと、Aikido のコードスキャンから特定のファイルやディレクトリを非表示にできます。これにより、シークレット、SAST issue、ロックファイル、コード品質のスキャンが自動的に除外されます。

exclude:
paths:
- src/useless-folder
- docs/example.js
- .gen.ts

CVEを無視するには、.aikido yamlファイルに理由とともに追加します。Aikido のUIにも、これらの特定のCVEが .aikido ファイルの記載により無視されていることが表示されます。

ignore:
cves:
CVE-2020-8203:
reason: We do not care about this CVE
CVE-2025-22869:
reason: We handle this
.aikido 設定ファイルによってHigh深刻度のCVEが引き下げられた例

コードコメントでSASTを無視する

コード内のコメントを使ってSASTの検出結果を無視することも可能です。

その他の .aikido のユースケース

Section titled “その他の .aikido のユースケース”

.aikido ファイルでは、リポジトリ固有のAutoFix動作も設定できます。

これを使って、カスタムブランチプレフィックスや、リポジトリ全体で単一のAutoFix PRを使う設定などを定義できます。

サポートされている autofix 設定と例については、AutoFix PR Configuration を参照してください。