Magical shell history
Go to file
2021-02-15 20:33:39 +00:00
.github/workflows Correct clippy usage 2021-02-14 18:16:53 +00:00
src Fix import message 2021-02-15 20:33:39 +00:00
.gitignore Initial commit 2020-10-05 00:59:28 +01:00
atuin.plugin.zsh Amend 2021-02-13 23:02:17 +00:00
Cargo.lock Bump version 2021-02-14 22:33:22 +00:00
Cargo.toml Bump version 2021-02-14 22:33:22 +00:00
LICENSE Create LICENSE 2021-02-14 16:22:25 +00:00
README.md Update README.md 2021-02-14 23:33:14 +00:00

A'tuin

Through the fathomless deeps of space swims the star turtle Great ATuin, bearing on its back the four giant elephants who carry on their shoulders the mass of the Discworld.

A'tuin manages and synchronizes your shell history! Instead of storing everything in a text file (such as ~/.history), A'tuin uses a sqlite database. While being a little more complex, this allows for more functionality.

As well as the expected command, A'tuin stores

  • duration
  • exit code
  • working directory
  • hostname
  • time
  • a unique session ID

Install

AUR

A'tuin is available on the AUR

yay -S atuin # or your AUR helper of choice

With cargo

atuin needs a nightly version of Rust + Cargo! It's best to use rustup for getting set up there.

rustup default nightly

cargo install atuin

From source

rustup default nightly
git clone https://github.com/ellie/atuin.git
cd atuin
cargo install --path .

Shell plugin

Once the binary is installed, the shell plugin requires installing:

zplug:

zplug "ellie/atuin", at:main

otherwise, clone the repo and source /path/to/repo/atuin.plugin.zsh in your .zshrc

Usage

By default A'tuin will rebind ctrl-r to use fzf to fuzzy search your history. You can specify a different fuzzy tool by changing the value of ATUIN_FUZZY:

export ATUIN_FUZZY=fzy

Import history

atuin import auto # detect shell, then import

or

atuin import zsh  # specify shell

List history

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 Discworld series of books.