Scroll to navigation

GRADLE(1) Gradle Command Line Manual GRADLE(1)

NAME

gradle - Adaptable, fast automation for all

SYNOPSIS

gradle [option...] [task...]

OPTIONS

A detailed guide of the command line interface is provided on Gradle's official website. The project itself does not provide a manpage, therefore maintaining it is error-prone and costly.

The summary of the options is provided below.

-?, -h, --help
Shows a help message.
Do not rebuild project dependencies.
Shows additional detail in the task listing. See the documentation section LISTING TASKS.
Specifies the build file. See the documentation section SELECTING BUILD.
Enables the Gradle build cache. Gradle will try to reuse outputs from previous builds.
Disables the Gradle build cache.
Specifies the settings file.
Specifies which type of console output to generate.

Set to plain to generate plain text only. This option disables all color and other rich output in the console output.

Set to auto (the default) to enable color and other rich output in the console output when the build process is attached to a console, or to generate plain text only when not attached to a console.

Set to rich to enable color and other rich output in the console output, regardless of whether the build process is not attached to a console. When not attached to a console, the build output will use ANSI control characters to generate the rich output.

Set to verbose to enable color and other rich output like the rich, but output more detailed message (task name, output, etc.)

Continues task execution after a task failure.
Only relevant projects are configured in this build run. This means faster builds for large multi-projects. See the documentation section CONFIGURATION ON DEMAND.
Disables the use of configuration on demand.
Sets a system property of the JVM, for example -Dmyprop=myvalue. See the documentation section GRADLE PROPERTIES AND SYSTEM PROPERTIES.
Log in debug mode (includes normal stacktrace). See the documentation section LOGGING.
Specifies the Gradle user home directory. The default is the .gradle directory in the user's home directory.
Run the build as a composite, including the specified build. See the documentation section COMPOSITE BUILDS.
Specifies an initialization script. See the documentation section INIT SCRIPTS.
Set log level to info. See the documentation section LOGGING.
Runs the build with all task actions disabled. See the documentation section DRY RUN.
Specifies that the build should operate without accessing network resources. See the documentation section CACHE COMMAND LINE OPTIONS.
Sets a project property of the root project, for example -Pmyprop=myvalue. See the documentation section GRADLE PROPERTIES AND SYSTEM PROPERTIES.
Specifies the start directory for Gradle. Defaults to current directory. See the documentation section SELECTING BUILD.
Build projects in parallel. Gradle will attempt to determine the optimal number of executor threads to use. This option should only be used with decoupled projects (see the documentation section DECOUPLED PROJECTS). For limitations of this option please see the documentation section PARALLEL EXECUTION.
Disables parallel execution to build projects.
Sets the maximum number of workers that Gradle may use. For example --max-workers=3. The default is the number of processors.
Profiles build execution time and generates a report in the buildDir /reports/profile directory. See the documentation section PROFILING BUILD.
Specifies the project-specific cache directory. Default value is .gradle in the root project directory.
Log errors only. See the documentation section LOGGING.
Forces scripts to be recompiled, bypassing caching. This option has been deprecated and is scheduled to be removed Gradle 5.0. You should avoid using it.
Refresh the state of dependencies. See the documentation section CACHE COMMAND LINE OPTIONS.
Specifies that any task optimization is ignored.
Print out the full (very verbose) stacktrace for any exceptions. See the documentation section LOGGING.
Print out the stacktrace also for user exceptions (e.g. compile error). See the documentation section LOGGING.
Creates a build scan. Gradle will auto-apply the build scan plugin with a compatible version. For more information about build scans, please visit <https://gradle.com/build-scans>.
Disables the creation of a build scan. For more information about build scans, please visit <https://gradle.com/build-scans>.
Enables continuous building - Gradle will automatically re-run when changes are detected.
Don't search in parent directories for a settings.gradle file.
Prints version info.
Set log level to warn. See the documentation section LOGGING
Specifies a task to be excluded from execution. See the documentation section EXCLUDING TASKS FROM THE COMMAND LINE.

The above information is printed to the console when you execute gradle -h.

DAEMON COMMAND-LINE OPTIONS

The documentation section 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.

Uses the Gradle daemon to run the build. Starts the daemon if not running or existing daemon busy. the documentation section GRADLE DAEMON contains more detailed information when new daemon processes are started.
Does not use the Gradle daemon to run the build.
Starts the Gradle daemon in the foreground. Useful for debugging or troubleshooting because you can easily monitor the build execution.
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.
List running and recently stopped Gradle daemons. Only displays daemons of the same Gradle version.
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.

SYSTEM PROPERTIES

The following system properties are available for the gradle command. Note that command-line options take precedence over system properties.

   Specifies the Gradle user home directory.

The documentation section GRADLE CONFIGURATION PROPERTIES contains specific information about Gradle configuration available via system properties.

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.

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="-Dorg.gradle.daemon=true" to use the Gradle daemon without needing to use the --daemon option every time you run Gradle. the documentation section GRADLE CONFIGURATION PROPERTIES contains more information about ways of configuring the daemon without using environmental variables, e.g. in more maintainable and explicit way.
Specifies the Gradle user home directory (which defaults to “USER_HOME/.gradle” if not set).
Specifies the JDK installation directory to use.

SEE ALSO

<https://docs.gradle.org/current/userguide/command_line_interface.html>

AUTHORS

Gradle developers

2022-08-21 Gradle 4.4.1