> 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 アカウントの作成方法の詳細](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. Local Scanner の実行
あとは、リポジトリでスキャナーを実行するだけです。\
\
ローカルスキャナーは、デフォルトブランチでのみ起動されるようにしてください。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).
release gating mode または PR gating mode で scanner を実行することもできます。release gating mode は、リリース前にリポジトリをスキャンする際に役立ちます。潜在的なリリースの前に未解決の問題がないことを確認できるためです。release gating mode で実行すると、スキャン完了後に選択した重大度以上の未解決の問題がある場合、scanner プロセスは失敗します。PR gating mode は、PR 内で新たに導入された可能性のある問題をスキャンするために使用できます。
release または PR gating mode に関する詳細は、次で確認できます [この記事](/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.