> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/docs/docs-ja/pr-torirsunogtingu/cli-for-pr-and-release-gating/aikido-cli-release-and-pr-gating.md).

# Aikido CLI: リリースゲート

> Aikido Security CIクライアントを使用すると、Jenkins や CircleCI などのカスタム CI パイプラインに Aikido Security のスキャンを統合できます。これにより、セキュリティスキャンをビルドプロセスの一部に含められます。

### ユースケース <a href="#use-cases" id="use-cases"></a>

* **リリースゲーティング**：コミットに基づいて新しいリリースまたはビルドをブロックします。

### ステップごとのガイド <a href="#step-by-step-guide" id="step-by-step-guide"></a>

**ステップ 1**：Aikido CIクライアントをグローバルにインストールします。こちらを参照してください [CI APIクライアント](https://www.npmjs.com/package/@aikidosec/ci-api-client).

```sh
# npm ユーザー向け
$ npm install -g @aikidosec/ci-api-client

# yarn ユーザー向け
$ yarn global add @aikidosec/ci-api-client
```

**ステップ2**：Aikido APIキーを設定します

1. APIキーは [継続的インテグレーション設定ページ](https://app.aikido.dev/settings/integrations/continuous-integration).
2. APIキーをグローバルに設定します：

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

**ステップ 3**：リリースまたはプルリクエストのスキャンを実行します\
&#x20;`scan-release` コマンドは **リリースゲーティング**.

```
$ aikido-api-client scan-release <repository_id or repository_name> <commit_id>
```

**オプション**:

* `--no-fail-on-dependency-scan`：新しい依存関係の脆弱性が見つかってもビルドを失敗させません。
* `--fail-on-sast-scan`：新しい SAST の問題が検出された場合、スキャンを失敗させます。
* `--fail-on-iac-scan`：新しいインフラストラクチャ・アズ・コードの問題が見つかった場合、スキャンを失敗させます。
* `--fail-on-secrets-scan`：露出したシークレットが検出された場合、スキャンを失敗させます。
* `--minimum-severity-level="CRITICAL"`：スキャンを失敗／ブロックさせるための最小重大度レベル\
  オプション： `LOW`, `MEDIUM`, `HIGH`, `CRITICAL` （デフォルト： `CRITICAL`)
* `--poll-interval [interval]`：更新されたスキャン結果を確認するためのポーリング間隔を設定します（デフォルト：10）。
* `--sla-mode`：SLA を超過した未解決の問題のみで Aikido が失敗するようにします。

### より詳細なオプションについては <a href="#for-more-detailed-options" id="for-more-detailed-options"></a>

```
$ aikido-api-client help
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.aikido.dev/docs/docs-ja/pr-torirsunogtingu/cli-for-pr-and-release-gating/aikido-cli-release-and-pr-gating.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.