Ctrlk
Changelog NotificationsAPIAikido login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

ローカルイメージスキャン用CLIオプション

イメージスキャン CLI オプション:

使用法: aikido-local-scanner image-scan [options] <image>

イメージスキャンを実行します。

引数:
  image                            スキャンしたいイメージ。

オプション:
  --apikey <apikey>                スキャン結果を Aikdo に送信するための API キー。 (env: AIKIDO_API_KEY)
  --platform <platform>            プラットフォームを設定します（例: amd64 システムで arm64 イメージを取得する）
  --image-name <name>              スキャンするイメージの名前を指定します。これは、<image> 引数からイメージ名を推測する既定の動作を上書きします。イメージ名が適切でない場合に、説明的な名前を指定するために使用できます。
  --multi-arch <arch>              指定した各アーキテクチャごとに個別のスキャンを実行します（例: linux/amd64）。複数のアーキテクチャをスキャンするには、このオプションを複数回指定してください。各アーキテクチャは一意のイメージ名（<image-name>-<arch>）で報告され、--output-cyclonedx-json と組み合わせると、各アーキテクチャはそれぞれ独自のファイル（<name>-<arch>.json）に書き込まれます。ゲーティングモードではサポートされておらず、--platform と組み合わせることはできません。
  --tag <tag>                      レポート目的で、スキャン対象イメージのタグを指定します。これは、<image> または <image-name> 引数からタグを推測する既定の動作を上書きします。
  --debug                          コマンド出力に追加のデバッグ情報を表示します。
  --fail-on <severity>             スキャナーをゲーティングモードで実行し、指定した重大度以上で失敗させます。 (選択肢: "low", "medium", "high", "critical")
  --gating-mode <mode>             スキャナーをリリースゲーティングモードで実行するか、PR ゲーティングモードで実行するかを指定します。リリースゲーティングモードではメインブランチをスキャンし、リリースを妨げるべき問題があるかどうかを確認するまで待機します。プルリクエストモードでは、Aikido はブランチで新たに導入された脆弱性のみを検出します。比較を機能させるにはベースコミットとヘッドコミットを指定する必要があります。--fail-on フラグと組み合わせる必要があります (選択肢: "release", "pr", 既定: "release")
  --sla-mode                       リリースゲーティングモードでは、SLA を超過している問題でのみゲートを失敗させます。
  --base-commit-id <commit-id>     ベースコミット ID。Aikido が新規の検出結果かどうかを判断するために比較するコミットです。PR ゲーティングモードでのみ使用されます。
  --head-commit-id <commit-id>     ヘッドコミット ID。スキャン対象のコミットです。PR ゲーティングモードでのみ使用されます。
  --gating-result-output <output>  問題を書き出す JSON ファイル（ゲーティングモード実行時のみ）
  --no-fail-on-timeout             スキャン結果のポーリングがタイムアウトした場合でもプロセスを失敗させません（リリースゲーティングモードのみ）
  --max-polling-attempts <amount>  スキャン結果をポーリングする回数。既定値の 20 回で足りない場合は増やしてください（リリースゲーティングモードのみ）
  --linked-team-name <name>        イメージを関連付けるチーム名。
  --force-create-image-for-tag     既存のイメージのタグを更新するのではなく、タグ付きで Aikido に新しいイメージを作成します。
  --scan-timeout <timeout>         各スキャンのタイムアウト（ミリ秒）。既定値は 900000ms です。
  --output-cyclonedx-json <output> CycloneDX JSON SBOM を書き出す JSON ファイル。
  --enable-proxy                   HTTPS_PROXY 環境変数を使用してリクエストをプロキシします。
  --ca-bundle <path>               --enable-proxy 使用時に信頼するカスタムルート CA を含む PEM ファイルへのパス。 (env: AIKIDO_CA_BUNDLE)
  --linked-repository-name <name>  イメージを関連付けるリポジトリ名。
  -h, --help                       コマンドのヘルプを表示します

リポジトリスキャンの CLI オプションについては、 こちら.

一般的な使用例

以下に、一般的な使用例の設定例をいくつか示します。

イメージスキャンを実行したい

イメージスキャンを実行して、イメージをチーム「Cloud Team」に関連付けたい

イメージスキャンを実行して、イメージをチーム「Dev Team 1」と「Dev Team 2」に関連付けたい

イメージスキャンを実行して、SBOM を JSON ファイルに出力したい

1 回のコマンドで、レジストリ内のイメージに対して複数アーキテクチャのイメージスキャンを実行したい。これにより、アーキテクチャごとの結果を持つ個別のイメージがフィードに作成されます。

最終更新

役に立ちましたか？