aboutsummaryrefslogtreecommitdiffstats
path: root/docs/config.md
diff options
context:
space:
mode:
authorPatrick Decat <pdecat@gmail.com>2022-12-18 19:26:09 +0100
committerGitHub <noreply@github.com>2022-12-18 18:26:09 +0000
commited394afa82ef919937521e5ce72fc467cec203f9 (patch)
treebc7d078684089e71d0d96f22328c5c266ad22d28 /docs/config.md
parentBump debian from bullseye-20221024-slim to bullseye-20221205-slim (#638) (diff)
downloadatuin-ed394afa82ef919937521e5ce72fc467cec203f9.zip
Allow overriding filter and search modes from CLI (#635)
* Allow overriding filter and search modes from CLI arguments * Use session filter mode for bash up key binding * We precisely do not want to add quotes here so that all arguments are properly passed * Add --shell-up-key-binding hidden command argument and filter_mode_shell_up_key_binding configuration option to allow customizing the filter mode used when atuin is invoked from a shell up-key binding * Correct up binding for zsh Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
Diffstat (limited to 'docs/config.md')
-rw-r--r--docs/config.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/config.md b/docs/config.md
index 9a7e906d..e5ae4adb 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -49,7 +49,7 @@ auto_sync = true/false
### `update_check`
-Configures whether or not to automatically check for updates. Defaults to
+Configures whether or not to automatically check for updates. Defaults to
true.
```
@@ -143,6 +143,16 @@ Filter modes can still be toggled via ctrl-r
filter_mode = "host"
```
+### `filter_mode_shell_up_key_binding`
+
+The default filter to use when searching and being invoked from a shell up-key binding.
+
+Accepts exactly the same options as `filter_mode` above
+
+```
+filter_mode_shell_up_key_binding = "session"
+```
+
### `exit_mode`
What to do when the escape key is pressed when searching