wfxr.forgit/README.md
Wenxuan 0d2cddd67a Update README
Former-commit-id: 33ad1f70fe
2018-04-14 09:35:17 +08:00

84 lines
2 KiB
Markdown

# forgit
`forgit` is a utility tool for git taking advantage of fuzzy finder fzf.
## Install
Make sure you have [`fzf`](https://github.com/junegunn/fzf) installed.
### [zplug](https://github.com/zplug/zplug) (Recommend)
``` zsh
zplug 'wfxr/forgit', defer:1
```
### [antigen](https//github.com/zsh-users/antigen)
``` zsh
antigen bundle wfxr/forgit
```
### Manually
Clone this repo somewhere and source the `forgit.plugin.zsh` at ~/.zshrc.
## Commands
### ga
Interactive `git add`
![screenshot](screenshot-ga.png)
| Keybind | Action |
| ---------------- | -------------------------- |
| `<Tab>` | Mark/Unmark(and move down) |
| `<C-r>` | Reverse selection |
| `<Enter>` | Confirm and quit |
| `<C-j/n><C-k/p>` | Selection down/up |
| `<?>` | Toggle preview window |
| `<A-w>` | Toggle preview wrap |
| `<A-j><A-k>` | Preview down/up |
### glo
Interactive `git log`
![screenshot](screenshot-glo.png)
| Keybind | Action |
| ---------------- | --------------------- |
| `<Enter>` | Fullscreen preview |
| `<C-j/n><C-k/p>` | Selection down/up |
| `<?>` | Toggle preview window |
| `<A-w>` | Toggle preview wrap |
| `<A-j><A-k>` | Preview down/up |
### gd
Interactive `git diff`
| Keybind | Action |
| ---------------- | --------------------- |
| `<Enter>` | Fullscreen preview |
| `<C-j/n><C-k/p>` | Selection down/up |
| `<?>` | Toggle preview window |
| `<A-w>` | Toggle preview wrap |
| `<A-j><A-k>` | Preview down/up |
### gi
Interactive `.gitignore` generator
![screenshot](screenshot-gi.png)
### Tips
- Hit `q` to Quit from full screen preview any time.
- Install [`diff-so-fancy`](https://github.com/so-fancy/diff-so-fancy) to have better `diff` output.
- Call `gi` with arguments to get wanted `.gitignore` contents directly(eg, `gi c++`).
## License
[MIT](LICENSE.txt)