Skip to main content
Aikido Local Scan Setup
Linux Setup for Local Scanner

Linux Setup for Local Scanner

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 you to scan any repos locally own your own machine.

Requirements

We currently support the x86_64 operating system architecture.

Temporary folder​

The scanner creates a temporary local folder (default .aikidotmp) to perform certain actions:

  • Copy certain lockfiles to run efficient scanning.

  • Write the results of the scanners.

This folder is cleaned up after the scanning is finished.

In addition, some files are copied to the temporary operating directory. Ensure that enough space is available; we recommend a minimum of 2GB.​

How to set up Local Scanning

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 this token as argument --apikey when running the Local Scanner in your project .

2. Adding the Local Scanner to your project

Download the local scanner binary from the Aikido UI.

3. Running the Local Scanner

Now all that is left to run the scanner on your repository.

./aikido-local-scanner scan ./ --apikey AIK_CI_xxx --repositoryname DemoApp --branchname main

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 scanner names --scanners option. More information on CLI options can be found here.

Alternatively, you can use our Docker image to scan your repository. Ensure that you have Docker installed before proceeding. Navigate into the directory you want to scan and run a scan using a command like:

docker run --rm -v "$(pwd):/my-app" aikidosecurity/local-scanner scan /my-app --apikey AIK_CI_xxx --repositoryname RepoName --branchname main

4. 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.