Skip to content

Commit

Permalink
Add guide to enter_accept config (#57)
Browse files Browse the repository at this point in the history
I hated the default `enter` key behavior but changing it is so obscure
in the long list of config. Let's add it to the key binding page as this
is where I think most people will look it up.

---------

Co-authored-by: Ellie Huxtable <[email protected]>
  • Loading branch information
nghduc97 and ellie committed Jun 18, 2024
1 parent 44d5710 commit b94a4db
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/content/docs/configuration/key-binding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ eval "$(atuin init zsh)"

You can then choose to bind Atuin if needed, do this after the call to init.

## Enter key behavior

By default, the `enter` key will directly execute the selected comamnd instead of letting you edit it like the `tab` key. If you want to change this behavior, set `enter_accept = false` in your config. For more details: [enter_accept](https://docs.atuin.sh/configuration/config/#enter_accept).

## <kbd>Ctrl-n</kbd> key shortcuts

macOS does not have an <kbd>Alt</kbd> key, although terminal emulators can often be configured to map the <kbd>Option</kbd> key to be used as <kbd>Alt</kbd>. *However*, remapping <kbd>Option</kbd> this way may prevent typing some characters, such as using <kbd>Option-3</kbd> to type `#` on the British English layout. For such a scenario, set the `ctrl_n_shortcuts` option to `true` in your config file to replace <kbd>Alt-0</kbd> to <kbd>Alt-9</kbd> shortcuts with <kbd>Ctrl-0</kbd> to <kbd>Ctrl-9</kbd> instead:
Expand Down

0 comments on commit b94a4db

Please sign in to comment.