mirror of
https://github.com/wfxr/forgit.git
synced 2026-09-14 17:26:15 -04:00
144 lines
3.1 KiB
Markdown
144 lines
3.1 KiB
Markdown
# forgit
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
`forgit` is a utility tool for git taking advantage of fuzzy finder fzf.
|
|
|
|
## Installation
|
|
|
|
Make sure you have [`fzf`](https://github.com/junegunn/fzf) installed.
|
|
|
|
### Try Online
|
|
|
|
Run following command to try it without installing(for both `bash` and `zsh`):
|
|
``` bash
|
|
source <(curl -Ss https://raw.githubusercontent.com/wfxr/forgit/master/forgit.plugin.zsh)
|
|
```
|
|
|
|
### [zplug](https://github.com/zplug/zplug) (Recommend)
|
|
|
|
``` zsh
|
|
zplug 'wfxr/forgit', defer:1
|
|
```
|
|
|
|
### [zgen](https://github.com/tarjoilija/zgen)
|
|
```
|
|
zgen load wfxr/forgit
|
|
```
|
|
|
|
### [antigen](https//github.com/zsh-users/antigen)
|
|
|
|
```
|
|
antigen bundle wfxr/forgit
|
|
```
|
|
|
|
### Manually
|
|
|
|
**zsh**
|
|
|
|
Clone this repo and source `forgit.plugin.zsh` in `~/.zshrc`.
|
|
|
|
**bash**
|
|
|
|
Clone this repo and source `forgit.plugin.sh` in `~/.bashrc`.
|
|
|
|
## Commands
|
|
|
|
### ga
|
|
|
|
Interactive `git add` selector
|
|
|
|
|
|
|
|
### glo
|
|
|
|
Interactive `git log` viewer
|
|
|
|
|
|
|
|
### gi
|
|
|
|
Interactive `.gitignore` generator
|
|
|
|
|
|
|
|
### gd
|
|
|
|
Interactive `git diff` viewer
|
|
|
|
### gcf
|
|
|
|
Interactive `git checkout <file>` selector
|
|
|
|
### gss
|
|
|
|
Interactive `git stash` viewer
|
|
|
|
### gclean
|
|
|
|
Interactive `git clean` selector
|
|
|
|
|
|
## Default keybinds
|
|
|
|
| Keybind | Action |
|
|
| ---------- | --------------------- |
|
|
| `<Enter>` | Confirm |
|
|
| `<Tab>` | Toggle mark |
|
|
| `<C-k/p>` | Selection up |
|
|
| `<C-j/n>` | Selection down |
|
|
| `<A-k/p>` | Preview up |
|
|
| `<A-j/n>` | Preview down |
|
|
| `<A-w>` | Toggle preview wrap |
|
|
| `<?>` | Toggle preview window |
|
|
| `<C-r>` | Toggle selection |
|
|
| `<C-s>` | Toggle sort |
|
|
|
|
## Custom options
|
|
|
|
You can change the default aliases by defining these variables below.
|
|
(To disable all aliases, Set the `FORGIT_NO_ALIASES` flag.)
|
|
|
|
``` bash
|
|
# Define them before sourcing the plugin if you don't use any plugin manager.
|
|
forgit_log=glo
|
|
forgit_diff=gd
|
|
forgit_add=ga
|
|
forgit_ignore=gi
|
|
forgit_restore=gcf
|
|
forgit_clean=gclean
|
|
forgit_stash_show=gss
|
|
```
|
|
|
|
You can add custom fzf options for `forgit`, including keybinds, layout, etc.
|
|
(No need to repeat the options already defined in `FZF_DEFAULT_OPTS`)
|
|
|
|
``` bash
|
|
FORGIT_FZF_DEFAULT_OPTS="
|
|
--exact
|
|
--border
|
|
--cycle
|
|
--reverse
|
|
--height '80%'
|
|
"
|
|
```
|
|
## Enhancements
|
|
|
|
- [`diff-so-fancy`](https://github.com/so-fancy/diff-so-fancy): Improve `git diff` output.
|
|
|
|
- [`bat`](https://github.com/sharkdp/bat.git): Syntex highlight for `gitignore`.
|
|
|
|
- [`emoji-cli`](https://github.com/wfxr/emoji-cli): Emoji support for `git log`.
|
|
|
|
## Tips
|
|
|
|
- Hit `q` to quit from full screen preview any time.
|
|
- Commands like `glo`, `gd`, `gcf` and `gclean` accept path arguments to restrain the items listed in fzf(eg, `glo main.go test.go`, `gclean output/`).
|
|
- Call `gi` with arguments to get the wanted `.gitignore` contents directly(eg, `gi cmake c++`).
|
|
|
|
## [License](LICENSE.txt)
|
|
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2018 Wenxuan Zhang
|