From b530d39c3f9bdbc780b901063002e60253efe841 Mon Sep 17 00:00:00 2001
From: Ellie Huxtable <ellie@elliehuxtable.com>
Date: Thu, 23 Nov 2023 09:59:56 +0000
Subject: [PATCH] docs: new stats config (#1412)

---
 atuin-client/config.toml   | 15 +++++++++++++++
 docs/docs/config/config.md | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)

diff --git a/atuin-client/config.toml b/atuin-client/config.toml
index ec77198f..2e333b92 100644
--- a/atuin-client/config.toml
+++ b/atuin-client/config.toml
@@ -124,3 +124,18 @@
 ## Defaults to true. If enabled, upon hitting enter Atuin will immediately execute the command. Press tab to return to the shell and edit.
 # This applies for new installs. Old installs will keep the old behaviour unless configured otherwise.
 enter_accept = true
+
+#[stats]
+# Set commands where we should consider the subcommand for statistics. Eg, kubectl get vs just kubectl
+#common_subcommands = [
+#  "cargo",
+#  "go",
+#  "git",
+#  "npm",
+#  "yarn",
+#  "pnpm",
+#  "kubectl",
+#]
+# 
+# Set commands that should be totally stripped and ignored from stats
+#common_prefix = ["sudo"]
diff --git a/docs/docs/config/config.md b/docs/docs/config/config.md
index 026a771d..ffef155e 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.