Get started with build scans

A build scan is a shareable record of a build that provides insights into what happened and why. You can create a build scan at scans.gradle.com for free.

Publishing build scans to scans.gradle.com transmits information about your build and environment to Gradle's servers. The information is only accessible via a randomly generated link, printed at the end of the build. You can delete the build scan when you are finished.

Gradle Enterprise provides build scans with additional features, and more, installable on-premises.

Create a build scan in 30 seconds

Get started with build scans with the quickstart sample project, or follow the steps below with your project.

Run your build with the --scan option.

gradle build --scan

1. Apply the plugin

Add this code snippet to the top of the build.gradle file of the root project, below any buildscript { … } sections if present.

plugins { id 'com.gradle.build-scan' version '1.16' } buildScan { licenseAgreementUrl = 'https://gradle.com/terms-of-service' licenseAgree = 'yes' }

2. Run your build

Run your build with the --scan option.

gradle build --scan

Learn more

You can create builds scans for all of your builds via an init script. You can enable automatic publication. You can even extend build scans with custom data, and more. Learn how via the Build Scans User Manual.