diff options
| author | Ellie Huxtable <e@elm.sh> | 2021-04-26 11:50:31 +0100 |
|---|---|---|
| committer | Ellie Huxtable <e@elm.sh> | 2021-04-26 11:57:30 +0100 |
| commit | 7b5c3d543d198a18884c990d540f5debc8a4d8d5 (patch) | |
| tree | ffc6b9121f1b1299f1b30a26322e1988683c06c7 /README.md | |
| parent | 4f16e8411e24891b140690798c47747f5c9bb91e (diff) | |
Support bash, resolves #3
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 35 insertions, 8 deletions
@@ -1,7 +1,6 @@ <h1 align="center"> Atuin </h1> -<em align="center">Magical shell history</em> <p align="center"> <a href="https://github.com/ellie/atuin/actions?query=workflow%3ARust"><img src="https://img.shields.io/github/workflow/status/ellie/atuin/Rust?style=flat-square" /></a> @@ -30,6 +29,7 @@ ## Supported Shells - zsh +- bash # Quickstart @@ -43,12 +43,15 @@ atuin sync ## Install -### AUR +### Script (recommended) -Atuin is available on the [AUR](https://aur.archlinux.org/packages/atuin/) +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). ``` -yay -S atuin # or your AUR helper of choice +# 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 @@ -60,6 +63,14 @@ toolchain, then you can run: cargo install atuin ``` +### AUR + +Atuin is available on the [AUR](https://aur.archlinux.org/packages/atuin/) + +``` +yay -S atuin # or your AUR helper of choice +``` + ### From source ``` @@ -68,15 +79,31 @@ cd atuin cargo install --path . ``` -### Shell plugin +## 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 -Once the binary is installed, the shell plugin requires installing. Add +We need to setup some hooks, so first install bash-preexec: ``` -eval "$(atuin init)" +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 ``` -to your `.zshrc` +Then setup Atuin + +``` +echo 'eval "$(atuin init bash)"' >> ~/.bashrc +``` ## ...what's with the name? |