1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-21 11:51:57 +00:00
ohmyzsh/plugins/gradle/README.md
Marc Cornellà 610b2529d2 Clean up plugin READMEs and a few plugins
- fasd
- history
- mercurial
- pylint
- repo
- yii2
2020-03-11 19:57:46 +01:00

30 lines
844 B
Markdown

# Gradle plugin
This plugin adds completions and aliases for [Gradle](https://gradle.org/).
To use it, add `gradle` to the plugins array in your zshrc file:
```zsh
plugins=(... gradle)
```
## Usage
This plugin creates a function called `gradle-or-gradlew`, which is aliased
to `gradle`, which is used to determine whether the current project directory
has a gradlew file. If `gradlew` is present it will be used, otherwise `gradle`
is used instead. Gradle tasks can be executed directly without regard for
whether it is `gradle` or `gradlew`. It also supports being called from
any directory inside the root project directory.
Examples:
```zsh
gradle test
gradle build
```
## Completion
This plugin uses [the completion from the Gradle project](https://github.com/gradle/gradle-completion),
which is distributed under the MIT license.