extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2024-11-09 01:45:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
✨ Magical shell history
87 Commits 59 Branches 34 Tags 61 MiB
Rust 95%
Shell 3.2%
Nix 0.5%
PLpgSQL 0.5%
Xonsh 0.4%
Other 0.4%
0610ae197f
Go to file
Ellie Huxtable 0610ae197f
Pre release polishing (#42) 
* Improve readme

* Add demo gif

* Update readme

* Add mac build

* Amend release config

* Update gif
2021-04-26 13:25:57 +00:00
.github Pre release polishing (#42) 2021-04-26 13:25:57 +00: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 Pre release polishing (#42) 2021-04-26 13:25:57 +00:00
Cargo.toml Pre release polishing (#42) 2021-04-26 13:25:57 +00: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 Pre release polishing (#42) 2021-04-26 13:25:57 +00:00
LICENSE Create LICENSE 2021-02-14 16:22:25 +00:00
README.md Pre release polishing (#42) 2021-04-26 13:25:57 +00: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

curl https://github.com/ellie/atuin/blob/main/install.sh | bash

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
curl https://github.com/ellie/atuin/blob/main/install.sh | 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.