> 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 プラットフォームにアップロードされます。この構成により、レポート目的で Local Scanner を CircleCI パイプラインへ簡単に統合できます。
## Local Scanning の設定方法
**前提条件**：Local Scanning を利用できるアカウントが作成済みであることを確認してください。 [Local Scanning アカウントの作成に関する詳細情報](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. 認証トークンを生成してコピーします。このトークンは 1 回しか表示できないので注意してください。
3. このトークンを引数として追加します `--apikey` を、プロジェクトで Local Scanner を実行する際に使用します。
4. 次へ移動して、このトークンを環境変数として保存してください **プロジェクト設定** > **環境変数** > **環境変数を追加**.
## 2. ローカルスキャナーを実行する
あとは、リポジトリでスキャナーを実行するだけです。\
\
ローカルスキャナーは必ずデフォルトブランチでのみ起動するようにしてください。Aikido では、デフォルトでリポジトリ内の1つのブランチについて依存関係とコードの問題をスキャンできます。通常は main または master ブランチです。そのため、Aikido プラットフォーム上でスキャン結果が混在しないよう、ローカルスキャナーはそのブランチでのみ実行することを推奨します。これをブランチフィルターで指定できます。
## Docker を使用する
CircleCI Pipeline でローカルスキャナーを使う最も簡単な方法は、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.