myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add keyboard shortcuts to the Config/Keybinding chapter. (#875)

Browse source 
* Added Shortcuts section to keybinings

* Removed obvious shortcuts

* Update docs/docs/config/key-binding.md

Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>

* Update docs/docs/config/key-binding.md

Co-authored-by: Conrad Ludgate <oon@conradludgate.com>

* replaced cursor keys with emojis

* got back to utf symbols

---------

Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
Co-authored-by: Conrad Ludgate <oon@conradludgate.com>
This commit is contained in:
Maxim Uvarov 2023-04-18 04:24:25 +08:00 committed by GitHub
parent c7d89c1703
commit 7cc893d67d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/docs/config/key-binding.md
View file

@ -1,5 +1,7 @@
# Key binding # Key binding
## Shell
By default, Atuin will rebind both <kbd>Ctrl-r</kbd> and the up arrow. By default, Atuin will rebind both <kbd>Ctrl-r</kbd> and the up arrow.
You can also disable either the up-arrow or <kbd>Ctrl-r</kbd> bindings individually, by passing You can also disable either the up-arrow or <kbd>Ctrl-r</kbd> bindings individually, by passing
@ -28,7 +30,7 @@ eval "$(atuin init zsh)"
You can then choose to bind Atuin if needed, do this after the call to init. You can then choose to bind Atuin if needed, do this after the call to init.
# zsh ### zsh
Atuin defines the ZLE widget "\_atuin_search_widget" Atuin defines the ZLE widget "\_atuin_search_widget"
@ -43,7 +45,7 @@ bindkey '^[[A' _atuin_search_widget
bindkey '^[OA' _atuin_search_widget bindkey '^[OA' _atuin_search_widget
``` ```
# bash ### bash
``` ```
export ATUIN_NOBIND="true" export ATUIN_NOBIND="true"
@ -53,7 +55,7 @@ eval "$(atuin init bash)"
bind -x '"\C-r": __atuin_history' bind -x '"\C-r": __atuin_history'
``` ```
# fish ### fish
``` ```
set -gx ATUIN_NOBIND "true" set -gx ATUIN_NOBIND "true"
@ -63,3 +65,29 @@ atuin init fish | source
bind \cr _atuin_search bind \cr _atuin_search
bind -M insert \cr _atuin_search bind -M insert \cr _atuin_search
``` ```
## Atuin UI shortcuts
| Shortcut | Action |
| ----------------------------------------- | ----------------------------------------------------------------------------- |
| ctrl + r | Cycle through filter modes |
| ctrl + s | Cycle through search modes |
| alt + 1 to alt + 9 | Select item by the number located near it |
| ctrl + c / ctrl + d / ctrl + g / esc | Return original |
| ctrl + ⬅︎ / alt + b | Move the cursor to the previous word |
| ctrl + ➡️ / alt + f | Move the cursor to the next word |
| ctrl + h / ctrl + b / ⬅︎ | Move the cursor to the left |
| ctrl + l / ctrl + f / ➡️ | Move the cursor to the right |
| ctrl + a / home | Move the cursor to the start of the line |
| ctrl + e / end | Move the cursor to the end of the line |
| ctrl + backspace / ctrl + alt + backspace | Remove the previous word / remove the word just before the cursor |
| ctrl + delete / ctrl + alt + delete | Remove the next word or the word just after the cursor |
| ctrl + w | Remove the word before the cursor even if it spans across the word boundaries |
| ctrl + u | Clear the current line |
| ctrl + n / ctrl + j / ⬆ | Select the next item on the list |
| ctrl + p / ctrl + k / ⬇ | Select the previous item on the list |
| page down | Scroll search results one page down |
| page up | Scroll search results one page up |
| enter | Select highlighted item |
| ⬇ (with no entry selected) | Return original or return query depending on settings |
| ⬇ | Select the next item on the list |