stow/oh-my-zsh/.oh-my-zsh/plugins/gradle/README.md

   1 # Gradle plugin
   2
   3 This plugin adds completions and aliases for [Gradle](https://gradle.org/).
   4
   5 To use it, add `gradle` to the plugins array in your zshrc file:
   6
   7 ```zsh
   8 plugins=(... gradle)
   9 ```
  10
  11 ## Usage
  12
  13 This plugin creates a function called `gradle-or-gradlew`, which is aliased
  14 to `gradle`, which is used to determine whether the current project directory
  15 has a gradlew file. If `gradlew` is present it will be used, otherwise `gradle`
  16 is used instead. Gradle tasks can be executed directly without regard for
  17 whether it is `gradle` or `gradlew`. It also supports being called from
  18 any directory inside the root project directory.
  19
  20 Examples:
  21
  22 ```zsh
  23 gradle test
  24 gradle build
  25 ```
  26
  27 ## Completion
  28
  29 This plugin uses [the completion from the Gradle project](https://github.com/gradle/gradle-completion),
  30 which is distributed under the MIT license.