The 1.0 milestone 3 release brought a new API called the tooling API, which you can use for embedding Gradle. This API allows you to execute and monitor builds, and to query Gradle about the details of a build. The main audience for this API is IDE, CI server, other UI authors, or integration testing of your Gradle plugins. However, it is open for anyone who needs to embed Gradle in their application.
A fundamental characteristic of the tooling API is that it operates in a version independent way. This means that you can use the same API to work with different target versions of Gradle. The tooling API is Gradle wrapper aware and, by default, uses the same target Gradle version as that used by the wrapper-powered project.
Some features that the tooling API provides today:
In future we may support other interesting features:
The Tooling API is the official and recommended way to embed Gradle.
This means that the existing APIs, namely
and the open API (the UIFactory and friends),
are deprecated and will be removed in some future version of Gradle.
If you happen to use one of the above APIs, please consider changing your application to use the tooling API instead.
Please take a look at Chapter 19, The Gradle Daemon. The Tooling API uses the daemon all the time, e.g. you cannot officially use the Tooling API without the daemon. This means that subsequent calls to the Tooling API, be it model building requests or task executing requests can be executed in the same long-living process. Chapter 19, The Gradle Daemon contains more details about the daemon, specifically information on situations when new daemons are forked.
Since the tooling API is an interface for a programmer most of the documentation lives in the Javadoc.
This is exactly our intention - we don't expect this chapter to grow very much.
Instead we will add more code samples and improve the Javadoc documentation.
The main entry point to the tooling API is the
You can navigate from there and find code samples and other instructions.
Pretty effective way of learning how to use the tooling API is checking out and running
the samples that live in
If you're embedding Gradle and you're looking for exact set of dependencies the tooling API Jar requires
please look at one of the samples in
The dependencies are declared in the Gradle build scripts.
You can also find the repository declarations where the Jars are obtained from.