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 at scans.gradle.com for free. For a more advanced feature set, head over to Gradle Enterprise.

Publishing build scans to scans.gradle.com transmits this data to Gradle's servers. If you want to keep your data on your servers, check out Gradle Enterprise.

Create a build scan in 60 seconds

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 'com.gradle.build-scan' version '1.9' } buildScan { licenseAgreementUrl = 'https://gradle.com/terms-of-service' 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.

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