Get started with build scans

A build scan is a shareable and centralized record of a build that provides insights into what happened and why. By applying the build scan plugin to your project, you can create a build scan in the Gradle Cloud for free.

Explanation about what is transmitted to the Gradle Cloud by using build scans is available here.

If a public cloud isn't for you, you might be interested in Gradle Enterprise.

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

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 '' version '1.6' } buildScan { licenseAgreementUrl = '' licenseAgree = 'yes' }

Gradle 2.1 or later required.

2. Run your build

Run your build with the scan option.

gradle build --scan

Gradle 3.4 or later required.

gradle build -Dscan

Gradle 2.1 or later required.

When the build is finished,
follow the link to your build scan.

3. Learn more

There's more to build scans.

You can create builds scans for all of your builds via an init script. You can enable automatic publication (i.e. no need for -Dscan). You can even extend build scans with custom data, and more.

Learn how via the manual