[[command_line_interface_basics]]
= Command-Line Interface Basics

The command-line interface is the primary **method of interacting with Gradle** outside the IDE.

image::gradle-basic-2.png[]

Use of the <<gradle_wrapper.adoc#gradle_wrapper_reference, Gradle Wrapper>> is highly encouraged.

Substitute `./gradlew` (in macOS / Linux) or `gradlew.bat` (in Windows) for `gradle` in the following examples.

<4> Contains the JAR file and configuration of the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>>.
<5> Project-specific <<build_environment.adoc#sec:gradle_configuration_properties,Gradle configuration properties>>.
<6> Scripts for executing builds using the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>>.

include::github-actions.adoc[leveloffset=+2]
include::travis-ci.adoc[leveloffset=+2]

[[part:reference]]
== **REFERENCE**

include::command_line_interface.adoc[leveloffset=+2]
include::gradle_wrapper.adoc[leveloffset=+2]
include::plugin_reference.adoc[leveloffset=2]
include::third_party_integration.adoc[leveloffset=2]

== GRADLE DSLs and API

include::groovy_build_script_primer.adoc[leveloffset=+2]

[listing.terminal.sample-command]
----
$ ./gradlew build

BUILD SUCCESSFUL
14 actionable tasks: 14 executed
----

The project provides the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>> as part of the repository.
It is a recommended practice for any Gradle project as it enables your project to built on CI without having to install the Gradle runtime.

+
This lets you package a custom Gradle distribution containing custom build logic and plugins. You can combine this with the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle wrapper>> to make custom logic available to all builds in your enterprise.

If more than one init script is found, they will all be executed in the order specified above.

[listing.terminal.sample-command]
----
$ ./gradlew build

BUILD SUCCESSFUL
14 actionable tasks: 14 executed
----

The project provides the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>> as part of the repository.
It is a recommended practice for any Gradle project as it enables your project to built on CI without having to install the Gradle runtime.

 * <<teamcity.adoc#build_teamcity,TeamCity>>
 * <<travis-ci.adoc#build_travis,Travis CI>>

Even if you don't use one of the above, you can almost certainly configure your CI platform to use the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>> scripts.

== How to integrate with Gradle

There are two main ways to integrate a tool with Gradle:

 * The Gradle build uses the tool

The initialization scripts come bundled with the distribution and are applied every time the build is run.
Developers only need to point their checked-in <<gradle_wrapper.adoc#gradle_wrapper_reference,Wrapper>> files to the URL of the custom Gradle distribution.

[listing.terminal.sample-command]
----
$ ./gradlew build

BUILD SUCCESSFUL
14 actionable tasks: 14 executed
----

The project provides the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>> as part of the repository.
It is a recommended practice for any Gradle project as it enables your project to built on CI without having to install the Gradle runtime.

If you followed the <<installation.adoc#installation,installation instructions>>, and aren’t able to execute your Gradle build, here are some tips that may help.

If you installed Gradle outside of just invoking the <<gradle_wrapper.adoc#gradle_wrapper_reference,Gradle Wrapper>>, you can check your Gradle installation by running `gradle --version` in a terminal.

You should see something like this:

----
❯ gradle --version