diff options
| author | David Crespo <david-crespo@users.noreply.github.com> | 2026-02-18 12:35:06 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-02-18 10:35:06 -0800 |
| commit | 8519849285810d027386a2a94624197755b53701 (patch) | |
| tree | f00690a4f7d4b04c3e48bb7c11fac207293781bc | |
| parent | docs: Update config.md to remove NuShell support note (#3190) (diff) | |
| download | atuin-8519849285810d027386a2a94624197755b53701.zip | |
docs: Document `search.filters` (#3195)
| -rw-r--r-- | docs/docs/configuration/config.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/docs/configuration/config.md b/docs/docs/configuration/config.md index b349c272..8f0c6024 100644 --- a/docs/docs/configuration/config.md +++ b/docs/docs/configuration/config.md @@ -484,6 +484,21 @@ with motion sensitivity can find the live-updating timestamps distracting. Alternatively, set env var NO_MOTION +## search + +### `filters` + +Atuin version: >= 18.4 + +The list of filter modes available in interactive search, in the order they cycle through when you press ctrl-r. By default, all modes are enabled. Removing a mode from this list disables it entirely. The `workspace` mode is skipped when not in a git repository or when `workspaces = false`. See [`filter_mode`](#filter_mode) for a description of each mode. + +The `filter_mode` setting selects the initial mode from this list. If `filter_mode` is set to a mode not in the list, the first available mode is used instead. + +```toml +[search] +filters = ["global", "host", "session", "directory"] +``` + ## Stats This section of client config is specifically for configuring Atuin stats calculations |