README.md 3 KB
Newer Older
1
## Introduction
Vimal Raj's avatar
Vimal Raj committed
2

3
4
The [mvn plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/mvn) provides many
[useful aliases](#aliases) as well as completion for the `mvn` command.
Vimal Raj's avatar
Vimal Raj committed
5

6
7
8
9
Enable it by adding `mvn` to the plugins array in your zshrc file:
```zsh
plugins=(... mvn)
```
Vimal Raj's avatar
Vimal Raj committed
10
11
12

## Aliases

13
14
15
The plugin aliases mvn to a either calls `mvnw` ([Maven Wrapper](https://github.com/takari/maven-wrapper))
if it's found, or the mvn command otherwise.

16
17
| Alias                | Command                                         |
|:---------------------|:------------------------------------------------|
18
19
20
21
22
23
| `mvn!`               | `mvn -f <root>/pom.xml`                         |
| `mvnag`              | `mvn archetype:generate`                        |
| `mvnboot`            | `mvn spring-boot:run`                           |
| `mvnc`               | `mvn clean`                                     |
| `mvncd`              | `mvn clean deploy`                              |
| `mvnce`              | `mvn clean eclipse:clean eclipse:eclipse`       |
24
| `mvnci`              | `mvn clean install`                             |
25
26
| `mvncie`             | `mvn clean install eclipse:eclipse`             |
| `mvncini`            | `mvn clean initialize`                          |
27
| `mvncist`            | `mvn clean install -DskipTests`                 |
28
| `mvncisto`           | `mvn clean install -DskipTests --offline`       |
29
| `mvncom`             | `mvn compile`                                   |
30
| `mvncp`              | `mvn clean package`                             |
31
| `mvnct`              | `mvn clean test`                                |
32
33
34
35
| `mvncv`              | `mvn clean verify`                              |
| `mvncvst`            | `mvn clean verify -DskipTests`                  |
| `mvnd`               | `mvn deploy`                                    |
| `mvndocs`            | `mvn dependency:resolve -Dclassifier=javadoc`   |
36
| `mvndt`              | `mvn dependency:tree`                           |
37
38
39
| `mvne`               | `mvn eclipse:eclipse`                           |
| `mvnjetty`           | `mvn jetty:run`                                 |
| `mvnp`               | `mvn package`                                   |
40
41
| `mvns`               | `mvn site`                                      |
| `mvnsrc`             | `mvn dependency:sources`                        |
42
43
44
45
46
47
48
49
50
51
52
53
54
| `mvnt`               | `mvn test`                                      |
| `mvntc`              | `mvn tomcat:run`                                |
| `mvntc7`             | `mvn tomcat7:run`                               |
| `mvn-updates`        | `mvn versions:display-dependency-updates`       |

## mvn-color

It's a function that wraps the mvn command to colorize it's output. Since Maven 3.5.0
the mvn command adds colored output, so this function will be soon removed from the
plugin.

It also has a bug where it won't print when mvn prompts for user input, _e.g._ when
using `archetype:generate`. See [#5052](https://github.com/robbyrussell/oh-my-zsh/issues/5052).