docs: new stats config (#1412)

This commit is contained in:
Ellie Huxtable 2023-11-23 09:59:56 +00:00 committed by GitHub
parent 0c9d7367c6
commit b530d39c3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 48 additions and 0 deletions

View File

@ -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"]

View File

@ -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.