Print out the stacktrace also for user exceptions (e.g. compile error). See Chapter 19,
Logging.
-u, --no-search-upwards
Don't search in parent directories for asettings.gradle file.
-v, --version
Prints version info.
-x, --exclude-task
Specifies a task to be excluded from execution. See Section 11.2, “Excluding tasks”.
The above information is printed to the console when you execute gradle -h.
C.1. Deprecated command-line options
The following options are deprecated and will be removed in a future version of Gradle:
-C, --cache
(deprecated) Specifies how compiled build scripts should be cached. Possible values are: re or on. Default value is on. You should use --recompile-scripts instead.
--no-opt
(deprecated) Specifies to ignore all task optimization. You should use --rerun-tasks instead.
--refresh
(deprecated) Refresh the state of resources of the type(s) specified. Currently only depende is supported. You should use --refresh-dependencies instead.
C.2. Daemon command-line options:
The Chapter 13, The Gradle Daemon contains more information about the daemon. For example it includes information how to turn on the daemon by default so that you can avoid using --daemon all the time.
--daemon
Uses the Gradle daemon to run the build. Starts the daemon if not running or existing daemon busy. Chapter 13, The Gradle Daemon contains more detailed information when new daemon processes are started.
--foreground
Starts the Gradle daemon in the foreground. Useful for debugging or troubleshooting because you can easily monitor the build execution.
--no-daemon
Do not use the Gradle daemon to run the build. Useful occasionally if you have configured Gradle to always run with the daemon by default.
Page 337 of 343
--stop
Stops the Gradle daemon if it is running. You can only stop daemons that were started with the Gradle version you use when running --stop.
C.3. System properties
The following system properties are available for the gradle command. Note that command-line options take precedence over system properties.
gradle.user.home
Specifies the Gradle user home directory.
The Section 15.1, “Configuring the build environment via gradle.properties”contains specific information about Gradle configuration available via system properties.
C.4. Environment variables
The following environment variables are available for the gradle command. Note that command-line options and system properties take precedence over environment variables.
GRADLE_OPTS
Specifies command-line arguments to use to start the JVM. This can be useful for setting the system properties to use for running Gradle. For example you could set GRADLE_OPTS="-Do to use the Gradle daemon without needing to use the --daemon option every time you run Gradle. Section 15.1, “Configuring the build environment via gradle.properties”contains more information about ways of configuring the daemon without using environmental variables, e.g. in more maintainable and explicit way.
GRADLE_USER_HOME
Specifies the Gradle user home directory.
Page 338 of 343
D
Existing IDE Support and how to cope
without it
D.1. IntelliJ
Gradle has been mainly developed with Idea IntelliJ and its very good Groovy plugin. Gradle's buil script has also been developed with the support of this IDE. IntelliJ allows you to define any filepattern to be interpreted as a Groovy script. In the case of Gradle you can define such a pattern for build.gradle and settings.gradle. This will already help very much. What is missing is the classpath to the Gradle binaries to offer content assistance for the Gradle classes. You might add the Gradle jar (which you can find in your distribution) to your project's classpath. It does no really belong there, but if you do this you have a fantastic IDE support for developing Gradle scripts. Of course if you use additional libraries for your build scripts they would further pollute your project classpath.
We hope that in the future *.gradle files get special treatment by IntelliJ and you will be able to define a specific classpath for them.
D.2. Eclipse
There is a Groovy plugin for eclipse. We don't know in what state it is and how it would suppo Gradle. In the next edition of this user guide we can hopefully write more about this.
D.3. Using Gradle without IDE support
What we can do for you is to spare you typing things like throw new org.gradle.api.tasks. and just type throw new StopExecutionException() instead. We do this by automatically adding a set of import statements to the Gradle scripts before Gradle executes them. Listed below are the imports added to each script.
Page 339 of 343
Figure D.1. gradle-imports
import org.gradle.* import org.gradle.util.* import org.gradle.api.*
import org.gradle.api.artifacts.* import org.gradle.api.artifacts.dsl.* import org.gradle.api.artifacts.maven.* import org.gradle.api.artifacts.specs.* import org.gradle.api.execution.* import org.gradle.api.file.*
import org.gradle.api.resources.* import org.gradle.api.initialization.* import org.gradle.api.invocation.* import org.gradle.api.java.archives.* import org.gradle.api.logging.*
import org.gradle.api.plugins.*
import org.gradle.plugins.ide.eclipse.* import org.gradle.plugins.ide.idea.* import org.gradle.plugins.jetty.* import org.gradle.api.plugins.quality.*
import org.gradle.api.plugins.announce.* import org.gradle.api.specs.*
import org.gradle.api.tasks.*
import org.gradle.api.tasks.bundling.* import org.gradle.api.tasks.diagnostics.* import org.gradle.api.tasks.compile.* import org.gradle.api.tasks.javadoc.* import org.gradle.api.tasks.testing.* import org.gradle.api.tasks.util.* import org.gradle.api.tasks.wrapper.* import org.gradle.process.*
[26] Gradle is built with Gradle
Page 340 of 343
Gradle User Guide
A
Artifact
??
B
Build Script
??
C
Configuration
See Dependency Configuration.
Configuration Injection
??
D
DAG
See Directed Acyclic Graph.
Dependency
See External Dependency.
See Project Dependency.
??
Dependency Configuration
??
Dependency Resolution
??
Directed Acyclic Graph
A directed acyclic graph is a directed graph that contains no cycles. In Gradle each task to execute represents a node in the graph. A dependsOn relation to another task will add this other task as a node (if it is not in the graph already) and create a directed edge between those two nodes. Any dependsOn relation will be validated for cycles. There must be no way to start at certain node, follow a sequence of edges and end up at the original node.
Domain Specific Language
A domain-specific language is a programming language or specification language dedicated to a particular problem domain, a particular problem representation technique, and/or a
particular solution technique. The concept isn't new—special-purpose programming languages and all kinds of modeling/specification languages have always existed, but the term has become more popular due to the rise of domain-specific modeling.
DSL
See Domain Specific Language.
E
External Dependency
??
Extension Object
??
I
Init Script
A script that is run before the build itself starts, to allow customization of Gradle and the build.
Initialization Script
See Init Script.
P
Plugin
??
Project
??
Project Dependency
??
Publication
??
R
Repository
??
S
Source Set
??
T
Task
??
Transitive Dependency
??