summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Huxtable <e@elm.sh>2021-02-14 22:47:22 +0000
committerGitHub <noreply@github.com>2021-02-14 22:47:22 +0000
commit26bf61ff670e342c261ac78df11e44d51c64bcd9 (patch)
treed98cd4bcc6dc11f36d67bfc0f6ed9f4fc8d8b58a
parentb10d302e57a288a295e080fbb46570e6f891cdbd (diff)
Update README.md
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
index dad5d6d4..86aa6191 100644
--- a/README.md
+++ b/README.md
@@ -73,6 +73,42 @@ atuin import zsh # specify shell
atuin history list
```
+### Stats
+
+A'tuin can calculate statistics for a single day, and accepts "natural language" style date input, as well as absolute dates:
+
+```
+$ 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 |
++---------------------+-------+
+```
+
## ...what's with the name?
A'tuin is named after "The Great A'tuin", a giant turtle from Terry Pratchett's