summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@elliehuxtable.com>2023-11-23 09:59:56 +0000
committerGitHub <noreply@github.com>2023-11-23 09:59:56 +0000
commitb530d39c3f9bdbc780b901063002e60253efe841 (patch)
tree91cb98544c14bd94f0411eae19fc28c267b3468f /docs
parent0c9d7367c66d5042348c46869ca4a8aa71aa6c86 (diff)
docs: new stats config (#1412)
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/config/config.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/docs/config/config.md b/docs/docs/config/config.md
index 026a771d6..ffef155ec 100644
--- a/docs/docs/config/config.md
+++ b/docs/docs/config/config.md
@@ -318,3 +318,36 @@ shell and give the user a chance to edit.
This technically defaults to true for new users, but false for existing. We
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.
+
+## Stats
+This section of client config is specifically for configuring Atuin stats calculations
+
+### common_subcommands
+
+Default
+
+```
+common_subcommands = [
+ "cargo",
+ "go",
+ "git",
+ "npm",
+ "yarn",
+ "pnpm",
+ "kubectl",
+]
+```
+
+Configures commands where we should consider the subcommand as part of the statistics. For example, consider `kubectl get` rather than just `kubectl`.
+
+### common_prefix
+
+Default
+
+```
+common_prefix = [
+ "sudo",
+]
+```
+
+Configures commands that should be totally stripped from stats calculations. For example, 'sudo' should be ignored.