> 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 パイプラインに簡単に統合できます。
## ローカルスキャンの設定方法
**前提条件**: ローカルスキャンを許可するアカウントを作成しておいてください。 [ローカルスキャンアカウントの作成に関する詳細](https://help.aikido.dev/en/articles/9070345-how-to-create-an-account-for-local-scanning-on-aikido).
### 1. 認証トークンを取得する
1. 次へ移動します [ローカルスキャナーのセットアップページ](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).
を指定することで可能です。リリースゲーティングモードや 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.