> 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/kdosukyan/local-code-scanning/circleci-setup-for-local-code-scanning.md).
# ローカルコードスキャンのためのCircleCIセットアップ
Aikido Security Local Scanner は、Aikido Security のスキャンをお使いの環境内で実行できるツールで、コードが組織の外に出ないことを保証します。スキャンはローカルで実行され、その結果は Aikido Security プラットフォームにアップロードされます。この構成により、ローカルスキャナーを CircleCI パイプラインに簡単に統合して、レポート目的で利用できます。
## ローカルスキャンの設定方法
**前提条件**: ローカルスキャンを利用できるアカウントを作成しておいてください。 [ローカルスキャン用アカウントの作成に関する詳細](https://help.aikido.dev/en/articles/9070345-how-to-create-an-account-for-local-scanning-on-aikido).
### 1. 認証トークンを取得する
1. 次へ移動 [Local Scanner 設定ページ](https://app.aikido.dev/settings/integrations/localscan).
2. 認証トークンを生成してコピーします。このトークンは一度しか表示できないことに注意してください。
3. このトークンを引数として追加します `--apikey` プロジェクトで Local Scanner を実行するときに。
4. 次の手順で、このトークンを環境変数として保存します： **プロジェクト設定** > **環境変数** > **環境変数を追加**.
## 2. ローカルスキャナーの実行
あとは、リポジトリでスキャナーを実行するだけです。\
\
ローカルスキャナーは必ずデフォルトブランチでのみ起動するようにしてください。デフォルトでは、Aikido はリポジトリ内の 1 つのブランチに対してのみ依存関係とコードの問題のスキャンをサポートしており、通常は main または master ブランチです。そのため、Aikido プラットフォーム上でスキャン結果が混在しないよう、ローカルスキャナーはそのブランチでのみ実行することを推奨します。これにはブランチフィルターを指定できます。
## Docker を使用する
CircleCI パイプラインでローカルスキャナーを使う最も簡単な方法は、当社の Docker イメージを使用することです。
例 `.circleci/config.yml` :
```yaml
version: 2.1
jobs:
run-aikio-scan:
docker:
- image: aikidosecurity/local-scanner:latest
steps:
- checkout:
path: my-app
- run:
name: "Aikido スキャンを実行"
command: aikido-local-scanner scan my-app --repositoryname my-app --branchname main --apikey "$AIKIDO_API_KEY"
workflows:
my-workflow:
jobs:
- run-aikio-scan:
filters:
branches:
only:
- main
```
次の `--branchname` オプションを使用してコマンドを実行します。
これがこのリポジトリの最初のスキャンである場合、Aikido は指定した名前のリポジトリを作成し、すべてのスキャン結果を含めます。以後のスキャン結果は、Aikido 内でこのリポジトリ名の下に集約されます。
デフォルトではすべてのスキャンタイプが実行されます。スキャンの一部のみ（例: SAST スキャンのみ）を実行したい場合は、 `--scan-types` オプションです。CLIオプションの詳細はこちらで確認できます [こちら](https://help.aikido.dev/en/articles/9027526-local-scanner-cli-options).
を指定してスキャンタイプを渡すことで実行できます。また、スキャナーをリリースゲーティングモードまたは PR ゲーティングモードで実行することもできます。リリースゲーティングモードは、公開前にリポジトリをスキャンする際に役立ち、リリース候補に開いている問題がないことを保証します。リリースゲーティングモードで実行すると、スキャン完了後に選択した重大度以上の未解決の問題がある場合、スキャナー処理は失敗します。PR ゲーティングモードは、PR に新たに導入された可能性のある問題をスキャンするために使用できます。
リリースゲーティングモードまたは PR ゲーティングモードの詳細は、 [この記事](/docs/docs-ja/kdosukyan/local-code-scanning/pr-gating-for-code-using-local-scanner.md).
## 3. スキャン結果を確認する
最初のスキャンが完了したら、Aikido Feed で結果を確認できます。指定した名前のリポジトリが作成され、スキャンのすべての結果が含まれます。
---
# 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/kdosukyan/local-code-scanning/circleci-setup-for-local-code-scanning.md?ask=&goal=
```
`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.