A fork of github.com/atuinsh/atuin w/ OIDC support because yes

Find a file

Ellie Huxtable 9356736ca1 Release v0.6.3 First proper release! - Update install script - Correct dependencies - Update workflow release script		2021-04-26 18:04:56 +01:00
.github	Release v0.6.3	2021-04-26 18:04:56 +01:00
atuin-client	Pre release polishing (#42 )	2021-04-26 13:25:57 +00:00
atuin-common	Pre release polishing (#42 )	2021-04-26 13:25:57 +00:00
atuin-server	Pre release polishing (#42 )	2021-04-26 13:25:57 +00:00
docs	Update docs, unify on SQLx, bugfixes (#40 )	2021-04-25 17:21:52 +00:00
src	Fix pipeline	2021-04-26 12:05:20 +01:00
.dockerignore	Optimise docker (#34 )	2021-04-14 17:40:50 +00:00
.gitignore	Use cargo workspaces (#37 )	2021-04-20 20:53:07 +00:00
Cargo.lock	Update dependencies properly	2021-04-26 16:13:32 +01:00
Cargo.toml	Update dependencies properly	2021-04-26 16:13:32 +01:00
demo.gif	Pre release polishing (#42 )	2021-04-26 13:25:57 +00:00
Dockerfile	Update docs, unify on SQLx, bugfixes (#40 )	2021-04-25 17:21:52 +00:00
install.sh	Release v0.6.3	2021-04-26 18:04:56 +01:00
LICENSE	Create LICENSE	2021-02-14 16:22:25 +00:00
README.md	Update readme	2021-04-26 15:48:42 +01:00

README.md

Atuin

magical shell history

animated

exit code, duration, time and command shown

store shell history in a sqlite database
backup encrypted shell history to the cloud
the same history across terminals, across session, and across machines
log exit code, cwd, hostname, session, command duration, etc
smart interactive history search to replace ctrl-r
calculate statistics such as "most used command"
old history file is not replaced

Documentation

Supported Shells

zsh
bash

Quickstart

sh <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)

atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
atuin import auto
atuin sync

Install

Script (recommended)

The install script will help you through the setup, ensuring your shell is properly configured. It will also use one of the below methods, preferring the system package manager where possible (AUR, homebrew, etc etc).

# do not run this as root, root will be asked for if required
sh <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)

With cargo

It's best to use rustup to get setup with a Rust toolchain, then you can run:

cargo install atuin

AUR

Atuin is available on the AUR

yay -S atuin # or your AUR helper of choice

From source

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. If you use the install script, this should all be done for you!

zsh

echo 'eval "$(atuin init zsh)"' >> ~/.zshrc

bash

We need to setup some hooks, so first install bash-preexec:

curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec.sh -o ~/.bash-preexec.sh
echo '[[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh' >> ~/.bashrc

Then setup Atuin

echo 'eval "$(atuin init bash)"' >> ~/.bashrc

...what's with the name?

Atuin is named after "The Great A'Tuin", a giant turtle from Terry Pratchett's Discworld series of books.