Skip to content

Getting Started

After following this guide you will be able to conduct scans in your local development environment and review the results in Licensight.

Download Licensight Scan

Download Licensight Scan. Open a shell and run the command depending on your operating system:

curl -O https://licensight.s3.eu-central-1.amazonaws.com/latest/linux/licensight-scan
chmod +x ./licensight-scan

Invoke-WebRequest https://licensight.s3.eu-central-1.amazonaws.com/latest/windows/licensight-scan.exe -OutFile licensight-scan.exe

curl -O https://licensight.s3.eu-central-1.amazonaws.com/latest/osx/licensight-scan
chmod +x ./licensight-scan

Create an access token

Create an access token if you didn't do until now. You can do so in the Licensight profile section which you reach by clicking on the bottom left icon. This will open the list of available access tokens. You can create a new one clicking the add button. Enter a name and confirm by clicking the "Save". You can copy the access token now. Store it somewhere safely as it is not available any more after closing the dialog.

Run the scan

Execute the following command to conduct a scan.

./licensight-scan generate \
    -d '<path_to_project_directory>' \
    -a '<name_of_the_application>' \
    -e <your_licensight_url_or_tenant> \
    -at <your_personal_access_token>

Sample:

./licensight-scan generate -d . -a my-app -e https://my-tenant.licensight.com -at token

Note: You can also configure the endpoint as -e my-tenant instead of using the full URL.

Open Licensight to review the results

Visit the application section of Licensight. You will find all applications including the one which was just scanned. You can open it by clicking the "Open" button. You will see the application overview which gives you a quick overview about the application.

Demo