Skip to main content
Local Code Scanning
Bamboo Setup for Local Code Scanning

Bamboo Setup for Local Code Scanning

The Aikido Security Local Scanner is a tool that enables you to perform Aikido Security scans within your environment, ensuring your code never leaves your premises. The scans take place locally, and the results are then uploaded to the Aikido Security platform. This setup allows easy integration of the Local Scanner into Bamboo for reporting purposes.

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.

1. Get your authentication token

  1. Go to the Local Scanner setup page

  2. Generate an authentication token and copy. Note that you will only be able to view this token once.

  3. Add the authentication token to the Plan variables in Bitbucket to make it available for use in the plan. To do this, you need to navigate to the plan configuration > Variables. There you can add the authentication token with AIKIDO_API_KEY as the key and the copied token contents as the value. You can also choose to define the variable on Project or Global level (see here).

2. Running the Local Scanner

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.

Using Docker

If your agent has the capability to run Docker, you can use the Aikido Local Scanner Docker image to run the scans. First, make sure there is 'Source Code Checkout' task to ensure the code is available to be scanned. After that add a 'Docker' task like this:

Select 'Run a Docker container' as the command. Our image can be found on Docker Hub.

Fill in the Container Command field like this: aikido-local-scanner scan . --apikey ${bamboo.AIKIDO_API_KEY} --repositoryname ${bamboo.planRepository.1.name} --branchname ${bamboo.planRepository.1.branch}

Using the binary

If your agent does not have the capability to run Docker, you can use the Aikido Local Scanner binary directly. To do this, download the correct binary from the Local Scanner Setup page.
Now you need to add this a capability to your agent.

  • Navigate to the Desired Agent:

    • In Bamboo, go to Build Resources > Agents.

    • Select the agent where you want to add the capability.

  • Add the Executable Capability:

    • In the Agent-specific capabilities section, click Add capability.

    • Choose Capability type > Executable.

    • In the Executable label, enter a name for the executable, such as Aikido Local Scanner.

    • In the Path field, specify the path to the aikido-local-scanner binary on the agent machine.


Now, you can use the Aikido Local scanner as a Task in your Plan. First, make sure there is 'Source Code Checkout' task to ensure the code is available to be scanned. After that add a 'Command' task like this:

As the executable, choose 'Aikido Local Scanner' and add the command parameters in the Argument field:
scan . --apikey ${bamboo.AIKIDO_API_KEY} --repositoryname ${bamboo.planRepository.1.name} --branchname ${bamboo.planRepository.1.branch}

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 scanners will be executed, if you'd like to run only a selection of scanners, you can do so by supplying the scan types --scan-types option. More information on CLI options can be found here.

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.

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.