付録D Gradle コマンドラインGradle Command Line

The gradle コマンドには次の使用方法があります:command has the following usage:

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

コマンドライン・オプションは下記のgradleコマンドリストに示されている物が利用可能です。 The command-line options available for the gradle command are listed below:

-?, -h, --help

Shows a help message.

ヘルプのメッセージを参照

-a, --no-rebuild

Do not rebuild project dependencies.

プロジェクトの依存関係をリビルドしません。

--all

Shows additional detail in the task listing. See 「タスクの一覧Listing tasks.

タスク実行時の応答の詳細状況を表示をします。 「タスクの一覧Listing tasksを参照。

-b, --build-file

Specifies the build file. See 「ビルドスクリプトを指定して実行するSelecting which build to execute.

ビルド対象のgradleファイルを指定します。「ビルドスクリプトを指定して実行するSelecting which build to execute参照。

-c, --settings-file

Specifies the settings file.

設定ファイルを指定します。

--continue

Continues task execution after a task failure.

タスクを失敗しても、実行処理を継続します。

--configure-on-demand (incubating)

Only relevant projects are configured in this build run. This means faster builds for large multi-projects. See 「Configuration on demand」.

-D, --system-prop

Sets a system property of the JVM, for example -Dmyprop=myvalue. See 「GradleプロパティとシステムプロパティGradle properties and system properties.

JVMの環境変数を設定します, 例えば-Dmyprop=myvalue「GradleプロパティとシステムプロパティGradle properties and system propertiesを参照。

-d, --debug

Log in debug mode (includes normal stacktrace). See 18章ロギング.

デバックモードのログ出力(スタックトレースを含みます)。18章ロギング参照。

-g, --gradle-user-home

Specifies the Gradle user home directory. The default is the .gradle directory in the user's home directory.

Gradleのユーザディレクトリを指定します。デフォルトはユーザディレクトリ配下の .gradleになります。

--gui

Launches the Gradle GUI. See 12章GradleのGUIを使う.

Gradle GUIを起動します。12章GradleのGUIを使う参照。

-I, --init-script

Specifies an initialization script. See 61章初期化スクリプト.

初期化スクリプトを指定します。61章初期化スクリプト参照。

-i, --info

Set log level to info. See 18章ロギング.

ログレベルをinfoに指定します。18章ロギング参照。

-m, --dry-run

Runs the build with all task actions disabled. See 「空実行Dry Run.

タスクを実行しない形でビルドを走らせます。「空実行Dry Run参照。

--no-color

Do not use color in the console output.

コンソールの出力をカラフルにしない指定。

--offline

Specifies that the build should operate without accessing network resources. See 「キャッシングに関するコマンドラインオプション Command line options to override caching.

ネットワークにアクセスしない形でビルドを実行する指定です。「キャッシングに関するコマンドラインオプション Command line options to override caching参照。

-P, --project-prop

Sets a project property of the root project, for example -Pmyprop=myvalue. See 「GradleプロパティとシステムプロパティGradle properties and system properties.

ルートプロジェクトに、プロジェクトプロパティを設定します。例えば -Pmyprop=myvalue「GradleプロパティとシステムプロパティGradle properties and system properties参照。

-p, --project-dir

Specifies the start directory for Gradle. Defaults to current directory. See 「ビルドスクリプトを指定して実行するSelecting which build to execute.

Gradleの実行ディレクトリを指定します。デフォルトはカレントディレクトリです。 「ビルドスクリプトを指定して実行するSelecting which build to execute参照。

--parallel (incubating)

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 「分離されたプロジェクト Decoupled Projects).

--parallel-threads (incubating)

Build projects in parallel, using the specified number of executor threads. For example--parallel-threads=3. This option should only be used with decoupled projects (see 「分離されたプロジェクト Decoupled Projects).

--profile

Profiles build execution time and generates a report in the buildDir/reports/profile directory. See 「ビルドのプロファイリングProfiling a build.

Profilesコマンドはビルド実行時にbuildDir/reports/profileディレクトリにタスクの実行時間をレポート出力します。 「ビルドのプロファイリングProfiling a build参照。

--project-cache-dir

Specifies the project-specific cache directory. Default value is .gradle in the root project directory. See 「キャッシング Caching.

プロジェクトのキャッシュディレクトリを指定します。 デフォルトは.gradleディレクトリ上のルートプロジェクトディレクトリになります。 「キャッシング Caching参照。

-q, --quiet

Log errors only. See 18章ロギング.

ログ出力をエラーのみにします。18章ロギング参照。

--recompile-scripts

Specifies that cached build scripts are skipped and forced to be recompiled. See 「キャッシング Caching.

ビルドキャッシュファイルを無視してリコンパイルを強制する指定です。 「キャッシング Caching参照。

--refresh-dependencies

Refresh the state of dependencies. See 「キャッシングに関するコマンドラインオプション Command line options to override caching.

依存状態をリフレッシュします。 「キャッシングに関するコマンドラインオプション Command line options to override caching参照。

--rerun-tasks

Specifies that any task optimization is ignored.

タスク最適化を無視する指定です。

-S, --full-stacktrace

Print out the full (very verbose) stacktrace for any exceptions. See 18章ロギング.

例外発生時にフルスタックトレースを出力します。18章ロギング参照。

-s, --stacktrace

Print out the stacktrace also for user exceptions (e.g. compile error). See 18章ロギング.

ユーザ例外のスタックトレースを出力します。(例えばコンパイルエラー) 18章ロギング参照。

-u, --no-search-upwards

Don't search in parent directories for a settings.gradle file.

親ディレクトリの settings.gradle ファイルを探しません。

-v, --version

Prints version info.

バージョン情報を表示します。

-x, --exclude-task

Specifies a task to be excluded from execution. See 「タスクを除外してビルドするExcluding tasks.

除外タスクを指定します。「タスクを除外してビルドするExcluding tasks参照。

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

gradle -hコマンドを実行するとき上記の情報は表示されます。

D.1. デーモン コマンドラインオプション:Daemon command-line options:

The 19章Gradleデーモン 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.

19章Gradleデーモン のリンクはデーモンに関しての情報を多く含みます。 例えば、デフォルトで--daemon指定をつける方法等

--daemon

Uses the Gradle daemon to run the build. Starts the daemon if not running or existing daemon busy. 19章Gradleデーモン contains more detailed information when new daemon processes are started.

Gradle デーモンの状態でビルドを実行します。 既存のデーモンが未実行 または 忙しければ 19章Gradleデーモン 新しいデーモンプロセスを実行します。

--foreground

Starts the Gradle daemon in the foreground. Useful for debugging or troubleshooting because you can easily monitor the build execution.

Gradle daemonをフォアグラウンドの状態で実行します。容易にビルド時の例外をモニターできるので、 デバックやトラブルシューティングに役立ちます。

--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.

対象のビルドを実行させる為にGradleデーモンを使いません。 デーモンモードで実行することをデフォルトにしていれば、時々有用です。

--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.

Gradleデーモンが実行されていれば停止します。 実行しているバージョンのGradleの--stopで停止させてください。

D.2. システムプロパティSystem properties

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

システムプロパティの設定には以下のgradleコマンドが利用可能です。 ただしコマンドラインオプションのシステムプロパティの指定が優先されることに注意

gradle.user.home

Specifies the Gradle user home directory.

Gradleユーザディレクトリの指定

The 「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties contains specific information about Gradle configuration available via system properties.

「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.properties にGradleの設定で利用可能なシステムプロパティの情報が記載されています。

D.3. 環境変数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コマンドが利用可能です。 ただしコマンドラインオプションの環境変数の指定が優先されることに注意

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="-Dorg.gradle.daemon=true" to use the Gradle daemon without needing to use the --daemon option every time you run Gradle. 「gradle.propertiesを使用したビルド環境の構築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.

JVMを始めるために使用するコマンドライン引数を指定します。 Gradleの実行のために使用させるのに役立つことができます。例えば GRADLE_OPTS="-Dorg.gradle.daemon=true"の指定は --daemonをコマンドラインで指定する事無く実行させることが出来ます。 「gradle.propertiesを使用したビルド環境の構築Configuring the build environment via gradle.propertiesに 環境変数を使う事無しに、デーモンモードでの設定をする情報が記載されています。 例えばより維持可能でより明示的な方法で。

GRADLE_USER_HOME

Specifies the Gradle user home directory (which defaults to “USER_HOME/.gradle” if not set).

Gradleのユーザディレクトリを指定します

JAVA_HOME

Specifies the JDK installation directory to use.