Aikido CLI: PRゲーティング

ステップ1: Aikido CIクライアントをグローバルにインストールします。CI API clientを参照してください。

# For npm users
$ npm install -g @aikidosec/ci-api-client

# For yarn users
$ yarn global add @aikidosec/ci-api-client

ステップ2: AikidoのAPIキーを設定します

$ aikido-api-client apikey <your-api-key-here>

ステップ3: プルリクエストのスキャンを実行します
scan コマンドはプルリクエストゲーティングに使用します。

$ aikido-api-client scan <repository_id or repository_name> <base_commit_id> <head_commit_id>

オプション:

--no-fail-on-dependency-scan: 新しい依存関係の脆弱性でビルドを失敗させないようにします。
--fail-on-sast-scan: 新しいSAST Issueが検出された場合にスキャンを失敗させます。
--fail-on-iac-scan: 新しいinfrastructure-as-codeのIssueが見つかった場合にスキャンを失敗させます。
--fail-on-secrets-scan: 露出したシークレットが検出された場合にスキャンを失敗させます。
--minimum-severity-level="CRITICAL": スキャンを失敗/ブロックさせる最小重大度レベル
選択肢: LOW、MEDIUM、HIGH、CRITICAL（デフォルト: CRITICAL）
--poll-interval [interval]: 更新されたスキャン結果を確認するポーリング間隔を設定します（デフォルト: 10）。

ステップ4: カスタムテスト結果をアップロードします（scan コマンドでのみサポート）
以下のコマンドを使って、任意でカスタムテスト結果をアップロードできます。

$ aikido-api-client upload --repository-id <repository_id> --type checkov --file <path_to_payload_file>

$ aikido-api-client help