# TeamCity Pipeline Setup for Local Code Scanning
By default, Aikido can scan your repositories in the cloud. If you do not wish to share access to your code, you can use the Local Scanning option. The Aikido Security Local Scanner is a tool that enables you to perform Aikido Security scans within your environment, in this case within TeamCity Pipelines. The scans take place in the pipeline and the results are then uploaded to the Aikido Security platform.
## How to set up Local Scanning
**Prerequisite**: make sure to have created an account that allows for Local Scanning. [More information on creating a Local Scanning Account](https://help.aikido.dev/en/articles/9070345-how-to-create-an-account-for-local-scanning-on-aikido).
### 1. Get your authentication token
1. Go to the [Local Scanner setup page](https://app.aikido.dev/settings/integrations/localscan).
2. Generate an authentication token and copy. Note that you will only be able to view this token once.
3. Add this token as argument `--apikey` when running the Local Scanner in your project.
4. Save this token as a pipeline secret.
### 2. Running the Local Scanner
Now all that is left to run the scanner on your repository.\
\
Make sure that the local scanner is only triggered for your default branch. By default, Aikido supports scanning one branch in your repository for dependency and code issues, typically the main or master branch. Therefore, we recommend running the local scanner exclusively on that branch to avoid mixing scan results on the Aikido platform. You can specify this when setting up your pipeline.
### Using Docker
The easiest way to use our local scanner in your TeamCity pipeline is by using our Docker image.\
\
Example YAML:
```yaml
jobs:
Job1:
name: Aikido Scan
steps:
- type: script
name: Run aikido scan
docker-image: aikidosecurity/local-scanner
script-content: >-
aikido-local-scanner scan ./ --apikey %AIKIDO_API_KEY%
--repositoryname MyRepo --branchname main
runs-on: Linux-Medium
```
Specify your preferred branch using the `--branchname` option when executing the command.
If this is the first scan for this repository, Aikido will create a repository with the name you specified, containing all the scanning results. Subsequent scan results will be collected under this repository name in Aikido.
By default all scan types will be executed, if you'd like to run only a selection of scans (eg only a SAST scan), you can do so by supplying the scan types via the `--scan-types` option. More information on CLI options can be found [here](https://help.aikido.dev/en/articles/9027526-local-scanner-cli-options).
You can also run the scanner in release or PR gating mode. Release gating mode is helpful when scanning your repository prior to releasing, as it ensures there are no open issues before a potential release. When running in release gating mode, the scanner process will fail when there are any open issues of the chosen severity or higher after the scan is finished. PR gating mode can be used to scan for any potentially newly introduced issues in a PR.
More information about release or PR gating mode can be found in [this article](https://help.aikido.dev/code-scanning/local-code-scanning/pr-gating-for-code-using-local-scanner).
### 3. Check your scanning results
After your first scan is done, you can go to the Aikido Feed to check out your results. A repository with the name you specified will have been created, containing all results from the scanning.
---
# Agent Instructions: 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:
```
GET https://help.aikido.dev/code-scanning/local-code-scanning/teamcity-pipeline-setup-for-local-code-scanning.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.