| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 1 | git-flow-completion |
| 2 | =================== |
| 3 | |
| Justin Hileman | f7390da | 2010-08-23 09:44:10 -0400 | [diff] [blame] | 4 | Bash and Zsh completion support for [git-flow](http://github.com/nvie/gitflow) |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 5 | |
| 6 | The contained completion routines provide support for completing: |
| 7 | |
| Justin Hileman | ae24ff3 | 2010-10-23 15:53:33 -0400 | [diff] [blame] | 8 | * git-flow init and version |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 9 | * feature, hotfix and release branches |
| Justin Hileman | ae24ff3 | 2010-10-23 15:53:33 -0400 | [diff] [blame] | 10 | * remote feature, hotfix and release branch names |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 11 | |
| 12 | |
| Justin Hileman | f7390da | 2010-08-23 09:44:10 -0400 | [diff] [blame] | 13 | Installation for Bash |
| 14 | --------------------- |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 15 | |
| 16 | To achieve git-flow completion nirvana: |
| 17 | |
| Justin Hileman | 5ee0c92 | 2010-10-30 14:33:09 -0400 | [diff] [blame] | 18 | 0. [Install git-completion](http://github.com/bobthecow/git-flow-completion/wiki/Install-Bash-git-completion). |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 19 | |
| 20 | 1. Install this file. Either: |
| 21 | |
| Justin Hileman | 1da3cb7 | 2010-05-12 14:38:18 -0400 | [diff] [blame] | 22 | a. Place it in a `bash_completion.d` folder: |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 23 | |
| Justin Hileman | 1da3cb7 | 2010-05-12 14:38:18 -0400 | [diff] [blame] | 24 | * /etc/bash_completion.d |
| 25 | * /usr/local/etc/bash_completion.d |
| 26 | * ~/bash_completion.d |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 27 | |
| 28 | b. Or, copy it somewhere (e.g. ~/.git-flow-completion.sh) and put the following line in |
| 29 | your .bashrc: |
| 30 | |
| 31 | source ~/.git-flow-completion.sh |
| 32 | |
| Justin Hileman | 3e77edb | 2010-08-05 13:40:10 -0400 | [diff] [blame] | 33 | 2. If you are using Git < 1.7.1: Edit git-completion.sh and add the following line to the giant |
| Justin Hileman | d017360 | 2010-08-05 13:18:12 -0400 | [diff] [blame] | 34 | $command case in _git: |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 35 | |
| Justin Hileman | d017360 | 2010-08-05 13:18:12 -0400 | [diff] [blame] | 36 | flow) _git_flow ;; |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 37 | |
| Zifei Tong | 5eda741 | 2010-08-22 13:22:27 +0800 | [diff] [blame] | 38 | |
| Justin Hileman | f7390da | 2010-08-23 09:44:10 -0400 | [diff] [blame] | 39 | Installation for Zsh |
| 40 | -------------------- |
| 41 | |
| 42 | To achieve git-flow completion nirvana: |
| 43 | |
| 44 | 0. Update your zsh's git-completion module to the newest verion -- |
| 45 | [available here](http://zsh.git.sourceforge.net/git/gitweb.cgi?p=zsh/zsh;a=blob_plain;f=Completion/Unix/Command/_git;hb=HEAD). |
| 46 | |
| 47 | 1. Install this file. Either: |
| 48 | |
| 49 | a. Place it in your .zshrc: |
| 50 | |
| 51 | b. Or, copy it somewhere (e.g. ~/.git-flow-completion.zsh) and put the following line in |
| 52 | your .zshrc: |
| 53 | |
| 54 | source ~/.git-flow-completion.zsh |
| 55 | |
| 56 | c. Or, use this file as an oh-my-zsh plugin. |
| 57 | |
| Justin Hileman | fd37e37 | 2010-04-26 13:30:18 -0400 | [diff] [blame] | 58 | |
| 59 | The Fine Print |
| 60 | -------------- |
| 61 | |
| 62 | Copyright (c) 2010 [Justin Hileman](http://justinhileman.com) |
| 63 | |
| 64 | Distributed under the [MIT License](http://creativecommons.org/licenses/MIT/) |