README.md 1.7 KB
Newer Older
Marc Cornellà's avatar
Marc Cornellà committed
1
# Git-Flow plugin
2

3
This plugin adds completion and aliases for the [`git-flow` command](https://github.com/nvie/gitflow).
4

5
6
7
To use it, add `git-flow` to the plugins array in your zshrc file:

```zsh
Marc Cornellà's avatar
Marc Cornellà committed
8
9
plugins=(... git-flow)
```
10

Marc Cornellà's avatar
Marc Cornellà committed
11
## Aliases
12

13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
| Alias   | Command                    | Description                            |
|---------|----------------------------|----------------------------------------|
| `gfl`   | `git flow`                 | Git-Flow command                       |
| `gfli`  | `git flow init`            | Initialize git-flow repository         |
| `gcd`   | `git checkout develop`     | Check out develop branch               |
| `gch`   | `git checkout hotfix`      | Check out hotfix branch                |
| `gcr`   | `git checkout release`     | Check out release branch               |
| `gflf`  | `git flow feature`         | List existing feature branches         |
| `gflh`  | `git flow hotfix`          | List existing hotfix branches          |
| `gflr`  | `git flow release`         | List existing release branches         |
| `gflfs` | `git flow feature start`   | Start a new feature: `gflfs <name>`    |
| `gflhs` | `git flow hotfix start`    | Start a new hotfix: `gflhs <version>`  |
| `gflrs` | `git flow release start`   | Start a new release: `gflrs <version>` |
| `gflff` | `git flow feature finish`  | Finish feature: `gflff <name>`         |
| `gflfp` | `git flow feature publish` | Publish feature: `gflfp <name>`        |
| `gflhf` | `git flow hotfix finish`   | Finish hotfix: `gflhf <version>`       |
| `gflrf` | `git flow release finish`  | Finish release: `gflrf <version>`      |
30
31

[More information about `git-flow` commands](https://github.com/nvie/gitflow/wiki/Command-Line-Arguments).