Skip to content


Switch branches/tags

Build Scan™ quickstart

This is an example project that you can use to experience the Build Scan™ service of Gradle Enterprise.

It is a small Java project that has the Gradle Enterprise Gradle Plugin already applied.

Create a Build Scan™

Follow these simple steps to create and publish a Build Scan™ on

  1. Clone this project
  2. Run ./gradlew build --scan
  3. Agree to the Terms of Service on the command line

The build should end with something similar to:

Publishing build scan...

Follow the green link shown at the end of the build to view your Build Scan™ on

Note: If you run a build without the --scan flag, no Build Scan™ will be created and no information will be sent.

Experiment with Build Scans

Create different kinds of Build Scans by locally modifying this quickstart project. Here are some ideas:

  • Edit src/main/java/example/ to introduce compile errors
  • Edit src/test/java/example/ to introduce test failures
  • Add more dependencies, more plugins, and more projects

Alternatively, enable one of your own builds to produce Build Scans by following the step-by-step instructions.

Learn more

Read the Gradle Enterprise Gradle Plugin User Manual to learn more about the Build Scan™ service of Gradle Enterprise and the Gradle Enterprise Gradle Plugin.

Need help?

Talk to us on the Gradle forum.

If you are completely new to the Gradle Build Tool, start here.


The Build Scan™ quickstart project is open-source software released under the Apache 2.0 License.


An example project to experience the Build Scan™ service of Gradle Enterprise with Gradle builds.



Code of conduct