From eff150570b368a3fa7a2cd7954c6e86cf4269952 Mon Sep 17 00:00:00 2001 From: Koichi Murase Date: Wed, 21 Feb 2024 17:39:55 +0900 Subject: [PATCH] docs(configuration): update version information (#28) Also, the description of a missing config `local_time` was added, and the minimum version requirements for the recently added configs were added. --- src/content/docs/configuration/config.mdx | 26 +++++++++++++++++++ .../docs/configuration/key-binding.mdx | 10 +++---- 2 files changed, 31 insertions(+), 5 deletions(-) diff --git a/src/content/docs/configuration/config.mdx b/src/content/docs/configuration/config.mdx index 97d2de7..9210b7e 100644 --- a/src/content/docs/configuration/config.mdx +++ b/src/content/docs/configuration/config.mdx @@ -143,6 +143,7 @@ filter_mode = "host" ``` ### `search_mode_shell_up_key_binding` +Atuin version: >= 17.0 The default searchmode to use when searching and being invoked from a shell up-key binding. @@ -167,6 +168,7 @@ filter_mode_shell_up_key_binding = "session" Defaults to the value specified for filter_mode. ### `workspaces` +Atuin version: >= 17.0 This flag enables a pseudo filter-mode named "workspace": the filter is automatically activated when you are in a git repository. Defaults to false. @@ -191,6 +193,7 @@ Which style to use. Possible values: `auto`, `full` and `compact`. Defaults to `auto`. This means that Atuin will automatically switch to `compact` mode when the terminal window is too short for `full` to display properly. ### `invert` +Atuin version: >= 17.0 Invert the UI - put the search bar at the top , Default to `false` @@ -215,6 +218,7 @@ Configure whether or not to show a preview of the selected command. Useful when the command is longer than the terminal width and is cut off. ### `max_preview_height` +Atuin version: >= 17.0 Configure the maximum height of the preview to show. @@ -223,6 +227,7 @@ Useful when you have long scripts in your history that you want to distinguish b Defaults to `4`. ### `show_help` +Atuin version: >= 17.0 Configure whether or not to show the help row, which includes the current Atuin version (and whether an update is available), a keymap hint, and the total amount of commands in your history. @@ -265,6 +270,7 @@ history_filter = [ ``` ### `secrets_filter` +Atuin version: >= 17.0 ``` secrets_filter = true @@ -289,6 +295,8 @@ ctrl_n_shortcuts = true ``` ### `network_timeout` +Atuin version: >= 18.0 + Default: 30 The max amount of time (in seconds) to wait for a network request. If any @@ -296,12 +304,23 @@ operations with a sync server take longer than this, the code will fail - rather than wait indefinitely. ### `network_connect_timeout` +Atuin version: >= 18.0 + Default: 5 The max time (in seconds) we wait for a connection to become established with a remote sync server. Any longer than this and the request will fail. +### `local_timeout` +Atuin version: >= 18.0 + +Default: 5 + +Timeout (in seconds) for acquiring a local database connection (sqlite). + ### `enter_accept` +Atuin version: >= 17.0 + Default: false Not supported by NuShell presently @@ -315,6 +334,8 @@ have set `enter_accept = true` in the default config file. This is likely to change to be the default for everyone in a later release. ### `keymap_mode` +Atuin version: >= 18.0 + Default: "emacs" The initial keymap mode of the interactive Atuin search (e.g. started by the @@ -331,6 +352,8 @@ by NuShell at present, where it will always trigger the Atuin search with the keymap mode `"emacs"`. ### `keymap_cursor` +Atuin version: >= 18.0 + Default: (empty dictionary) The terminal's cursor style associated with each keymap mode in the Atuin @@ -351,6 +374,8 @@ one associated with the keymap mode corresponding to the shell's keymap on the termination of the Atuin search. ### `prefers_reduced_motion` +Atuin version: >= 18.0 + Default: false Enable this, and Atuin will reduce motion in the TUI as much as possible. Users @@ -386,6 +411,7 @@ common_subcommands = [ Configures commands where we should consider the subcommand as part of the statistics. For example, consider `kubectl get` rather than just `kubectl`. ### `common_prefix` +Atuin version: >= 17.1 Default diff --git a/src/content/docs/configuration/key-binding.mdx b/src/content/docs/configuration/key-binding.mdx index ec8592e..5d38f48 100644 --- a/src/content/docs/configuration/key-binding.mdx +++ b/src/content/docs/configuration/key-binding.mdx @@ -67,7 +67,7 @@ If you'd like to customize your bindings further, it's possible to do so with cu Atuin defines the ZLE widgets "atuin-search" and "atuin-up-search". The latter can be used for the keybindings to the up key and similar keys. -Note: instead use the widget names "\_atuin\_search\_widget" and "\_atuin\_up\_search\_widget", respectively, in `atuin <= 17.2.1` +Note: instead use the widget names "\_atuin\_search\_widget" and "\_atuin\_up\_search\_widget", respectively, in `atuin < 18.0` ``` export ATUIN_NOBIND="true" @@ -81,10 +81,10 @@ 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 +"atuin-up-search-viins", and "atuin-up-search-vicmd" (`atuin >= 18.0`) 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. +(`atuin >= 18.0`) to start the Atuin search in respective keymap modes. ## bash @@ -105,11 +105,11 @@ 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 +`--keymap-mode=vim-insert` and `--keymap-mode=vim-normal` (`atuin >= 18.0`) 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. +(`atuin >= 18.0`) 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