utils-code/wfxr.forgit
1
0
Fork 0
mirror of https://github.com/wfxr/forgit.git synced 2026-09-10 07:16:23 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: add descriptions. close #102

Browse source
This commit is contained in:
Wenxuan Zhang 2020-08-05 11:12:10 +08:00
parent 938a795f61
commit 64c93ae585
1 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -76,19 +76,23 @@ source (curl -sSL git.io/forgit.fish | psub)
### ⌨ Keybinds
| Key | Action |
| :-------------------------------------------: | -------------------------|
| <kbd>Enter</kbd> | Confirm |
| <kbd>Tab</kbd> | Toggle mark and move up |
| <kbd>Shift</kbd> - <kbd>Tab</kbd> | Toggle mark and move down|
| <kbd>?</kbd> | Toggle preview window |
| <kbd>Alt</kbd> - <kbd>W</kbd> | Toggle preview wrap |
| <kbd>Ctrl</kbd> - <kbd>S</kbd> | Toggle sort |
| <kbd>Ctrl</kbd> - <kbd>R</kbd> | Toggle selection |
| <kbd>Ctrl</kbd> - <kbd>K</kbd> / <kbd>P</kbd> | Selection move up |
| <kbd>Ctrl</kbd> - <kbd>J</kbd> / <kbd>N</kbd> | Selection move down |
| <kbd>Alt</kbd> - <kbd>K</kbd> / <kbd>P</kbd> | Preview move up |
| <kbd>Alt</kbd> - <kbd>J</kbd> / <kbd>N</kbd> | Preview move down |
| Key | Action |
| :-------------------------------------------: | ------------------------- |
| <kbd>Enter</kbd> | Confirm |
| <kbd>Tab</kbd> | Toggle mark and move up |
| <kbd>Shift</kbd> - <kbd>Tab</kbd> | Toggle mark and move down |
| <kbd>?</kbd> | Toggle preview window |
| <kbd>Alt</kbd> - <kbd>W</kbd> | Toggle preview wrap |
| <kbd>Ctrl</kbd> - <kbd>S</kbd> | Toggle sort |
| <kbd>Ctrl</kbd> - <kbd>R</kbd> | Toggle selection |
| <kbd>Ctrl</kbd> - <kbd>Y</kbd> | Copy commit hash* |
| <kbd>Ctrl</kbd> - <kbd>K</kbd> / <kbd>P</kbd> | Selection move up |
| <kbd>Ctrl</kbd> - <kbd>J</kbd> / <kbd>N</kbd> | Selection move down |
| <kbd>Alt</kbd> - <kbd>K</kbd> / <kbd>P</kbd> | Preview move up |
| <kbd>Alt</kbd> - <kbd>J</kbd> / <kbd>N</kbd> | Preview move down |
\* Available when the selection contains a commit hash.
For linux users `FORGIT_COPY_CMD` should be set to make copy work. Example: `FORGIT_COPY_CMD='xclip -selection clipboard'`.
### ⚙ Options
@ -140,10 +144,14 @@ Complete loading order of fzf options is:
**Example**
```
# adds a keybind to drop the selected stash but do not quit fzf
# ctrl-d to drop the selected stash but do not quit fzf
FORGIT_STASH_FZF_OPTS='
--bind="ctrl-d:reload(git stash drop $(cut -d: -f1 <<<{}) 1>/dev/null && git stash list)"
'
# ctrl-e to view the logs in a vim buffer
FORGIT_LOG_FZF_OPTS='
--bind="ctrl-e:execute(echo {} |grep -Eo [a-f0-9]+ |head -1 |xargs git show |vim -)"
'
```
### 📦 Optional dependencies