Sigrid Local Runner

This documentation covers the Sigrid Local Runner, which is only used when you are part of a one-off assessment where your source code needs to remain on-premise. The Sigrid Local Runner cannot be used for Sigrid subscriptions.

The Local Runner does the following:

• Analyze your source code. This is done locally, so the source code will never leave your environment.
• Publish the analysis results to Sigrid. Your source code is not published to Sigrid.

Prerequisites

Before you can start using the Local Runner, you need the following:

• You need to install Docker. In most cases, the most convenient to run Docker locally is by installing Docker Desktop. Docker Desktop supports Windows, Mac, and Linux.
• A Sigrid license file. This is provided to you by SIG.
• Download and install the Local Runner. A download link is provided to you by SIG. The Local Runner supports Windows, Mac, and Linux.
• You will need local access to your source code that you want to analyze using the Local Runner.

Using the Local Runner

When you start the Local Runner, you’ll see something that looks like this:

The Local Runner checks if Docker is running. If you followed the prerequisites, you should see a green box confirming this:

You can now provide the Local Runner with the license file and the source code directory.

The license file is only valid for a limited time. If you see an error message that your license file has expired, notify your support contact to request a new one.

If you’re not seeing any red error messages, you’re good to go. You can now click the button to start analyzing your source code. This might take a while, depending on how large your source code is.

Optionally, you can click “show process output” to see the log output. This is purely for information purposes.

After the analysis has completed, you will see the following confirmation message. This indicates the Local Runner has successfully completed its analysis, and has published the analysis results to Sigrid. That means you’re done!

If your analysis results in an error, notify your support contact so we can try to help you out.

If you made a mistake, you can use the Local Runner multiple times. Whenever you use the Local Runner, the new analysis results will simply replace the old ones. You can continue to use the Local Runner for as long as your Sigrid license file is valid.

Supported technologies

The Local Runner is able to analyze over 250 different technologies. For a full overview, see the list of supported technologies and filter the table by “Local Runner”.

Support

You can find the name and contact details of your support contact in the same email that contains your Local Runner download link and Sigrid license file.