aboutsummaryrefslogtreecommitdiffstats
path: root/docs/stats.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/stats.md')
-rw-r--r--docs/stats.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/stats.md b/docs/stats.md
new file mode 100644
index 00000000..9c08ce19
--- /dev/null
+++ b/docs/stats.md
@@ -0,0 +1,36 @@
+# `atuin stats`
+
+Atuin can also calculate stats based on your history - this is currently a
+little basic, but more features to come
+
+```
+$ atuin stats day last friday
+
++---------------------+------------+
+| Statistic | Value |
++---------------------+------------+
+| Most used command | git status |
++---------------------+------------+
+| Commands ran | 450 |
++---------------------+------------+
+| Unique commands ran | 213 |
++---------------------+------------+
+
+$ atuin stats day 01/01/21 # also accepts absolute dates
+```
+
+It can also calculate statistics for all of known history:
+
+```
+$ atuin stats all
+
++---------------------+-------+
+| Statistic | Value |
++---------------------+-------+
+| Most used command | ls |
++---------------------+-------+
+| Commands ran | 8190 |
++---------------------+-------+
+| Unique commands ran | 2996 |
++---------------------+-------+
+```