diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 33 insertions, 22 deletions
@@ -41,13 +41,13 @@ I also made a youtube video to demonstrate the common usages The branch color distinguishes 5 situations between local and remote branches: -color | meaning ----|--- - white| local has no remote - green| local is the same as remote - red| local has diverged from remote - purple| local is ahead of remote (good for push) - yellow| local is behind remote (good for merge) +| color | meaning | +| ------ | ---------------------------------------- | +| white | local has no remote | +| green | local is the same as remote | +| red | local has diverged from remote | +| purple | local is ahead of remote (good for push) | +| yellow | local is behind remote (good for merge) | The choice of purple for ahead and yellow for behind is motivated by [blueshift](https://en.wikipedia.org/wiki/Blueshift) and [redshift](https://en.wikipedia.org/wiki/Redshift), @@ -57,11 +57,12 @@ See the [customization section](#custom). The additional status symbols denote -symbol | meaning ----|--- - `+`| staged changes - `*`| unstaged changes - `?`| untracked files/folders +| symbol | meaning | +| ------ | ----------------------- | +| `+` | staged changes | +| `*` | unstaged changes | +| `?` | untracked files/folders | +| `$` | stashed contents | The bookkeeping sub-commands are @@ -158,11 +159,21 @@ See [this stackoverflow post](https://stackoverflow.com/questions/51680709/color ## Auto-completion -Download -[.gita-completion.bash](https://github.com/nosarthur/gita/blob/master/.gita-completion.bash) -or -[.gita-completion.zsh](https://github.com/nosarthur/gita/blob/master/.gita-completion.zsh) -and source it in shell. +You can download the generated auto-completion file in the following locations for your specific shell. Alternatively, if you have installed `argcomplete` on your system, you can also directly run `eval "$(register-python-argcomplete gita -s SHELL)"` (e.g. `SHELL` as `bash`/`zsh`) in your dotfile. + +### Bash +Download [.gita-completion.bash](https://github.com/nosarthur/gita/blob/master/.gita-completion.bash) and source it in shell. + +### Zsh +There are 2 options : +- [.gita-completion.zsh](https://github.com/nosarthur/gita/blob/master/contrib.completion/zsh/.gita-completion.zsh). Use the help of gita command to display options. It uses the bash completion system for zsh. +Add `autoload -U +X bashcompinit && bashcompinit` in .zshrc and source the zsh file +- [_gita](https://github.com/nosarthur/gita/blob/master/contrib.completion/zsh/_gita_). +Completion more Zsh style. Copy it in a folder and add this folder path in `FPATH` variable. This completion file doesn't take account to command from cmds.json + +### Fish +Download [gita.fish](https://github.com/nosarthur/gita/tree/master/auto-completion/fish/gita.fish) and place it in `~/.config/fish/completions/` + ## <a name='superman'></a> Superman mode @@ -380,10 +391,10 @@ their results agree. ## Tips -effect | shell command ----|--- -enter `<repo>` directory|`` cd `gita ls <repo>` `` -delete repos in `<group>` | `gita group ll <group> \| xargs gita rm` +| effect | shell command | +| ------------------------- | ---------------------------------------- | +| enter `<repo>` directory | `` cd `gita ls <repo>` `` | +| delete repos in `<group>` | `gita group ll <group> \| xargs gita rm` | ## Contributing @@ -411,4 +422,4 @@ I haven't tried them but I heard good things about them. - [myrepos](https://myrepos.branchable.com/) - [repo](https://source.android.com/setup/develop/repo) - +- [mu-repo](https://github.com/fabioz/mu-repo) |