Skip to content

Commit

Permalink
docs(key-binding): describe custom keybindings for keymap_mode
Browse files Browse the repository at this point in the history
This describes the widgets and options introduced by
atuinsh/atuin#1570
  • Loading branch information
akinomyoga committed Jan 29, 2024
1 parent 6e1f3df commit 705214a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/content/docs/configuration/key-binding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ bindkey '^[[A' atuin-up-search
bindkey '^[OA' atuin-up-search
```

For the keybindings in vi mode, "atuin-search-viins", "atuin-search-vicmd",
"atuin-up-search-viins", and "atuin-up-search-vicmd" (`atuin >= 17.3`) can be
used in combination with the config
["keymap\_mode"](https://docs.atuin.sh/configuration/config/#keymap_mode)
(`atuin >= 17.3`) to start the Atuin search in respective keymap modes.

## bash

Atuin provides a bindable shell function "`_atuin_history`" for keybindings in
Expand All @@ -97,6 +103,13 @@ bind -x '"\e[A": __atuin_history --shell-up-key-binding'
bind -x '"\eOA": __atuin_history --shell-up-key-binding'
```

For the keybindings in the `vi` editing mode, the options
`--keymap-mode=vim-insert` and `--keymap-mode=vim-normal` (`atuin >= 17.3`) can
be additionally specified to the shell function `__atuin_history` in
combination with the config
["keymap\_mode"](https://docs.atuin.sh/configuration/config/#keymap_mode)
(`atuin >= 17.3`) to start the Atuin search in respective keymap modes.

## fish
Edit key bindings in FISH shell by adding the following to ~/.config/fish/config.fish

Expand Down

0 comments on commit 705214a

Please sign in to comment.