Update(docs) Add workspace to config.toml and config.md (#1157)

atuinsh · Aug 9, 2023 · 8080a17 · 8080a17 · vercel · Aug 9, 2023
1 parent 613218f
commit 8080a17
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/atuin-client/config.toml b/atuin-client/config.toml
@@ -38,6 +38,10 @@
 ## possible values: global, host, session, directory
 # filter_mode = "global"
 
+## With workspace filtering enabled, Atuin will filter for commands executed
+## in any directory within a git repositiry tree (default: false)
+# workspaces = false
+
 ## which filter mode to use when atuin is invoked from a shell up-key binding
 ## the accepted values are identical to those of "filter_mode"
 ## leave unspecified to use same mode set in "filter_mode"

diff --git a/docs/docs/config/config.md b/docs/docs/config/config.md
@@ -166,6 +166,16 @@ filter_mode_shell_up_key_binding = "session"
 
 Defaults to the value specified for filter_mode.
 
+### `workspace`
+
+This flag enables a pseudo filter-mode named "workspace": the filter is automatically
+activated when you are in a git repository. Defaults to false.
+
+With workspace filtering enabled, Atuin will filter for commands executed in any directory
+within a git repository tree.
+
+Filter modes can still be toggled via ctrl-r.
+
 ### `style`
 
 Which style to use. Possible values: `auto`, `full` and `compact`.