Installation

Recommended installation approach

Let’s get started! First up, you will want to install Atuin. The recommended approach is to use the installation script, which automatically handles the installation of Atuin including the requirements for your environment. It will do its best to use your system package manager wherever possible.

bash/zsh

bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)

fish

bash (curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh | psub)

Setup sync Move on to the next step, or read on to manually install Atuin instead.

Manual installation

Installing the binary

If you don’t wish to use the installer, the manual installation steps are as follows.

Cargo

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

cargo install atuin

Homebrew

brew install atuin

MacPorts

Atuin is also available in MacPorts

sudo port install atuin

Nix

This repository is a flake, and can be installed using nix profile:

nix profile install "github:atuinsh/atuin"

Atuin is also available in nixpkgs:

nix-env -f '<nixpkgs>' -iA atuin

Pacman

Atuin is available in the Arch Linux extra repository:

pacman -S atuin

XBPS

Atuin is available in the Void Linux repository:

sudo xbps-install atuin

Termux

Atuin is available in the Termux package repository:

pkg install atuin

Source

Atuin builds on the latest stable version of Rust, and we make no promises regarding older versions. We recommend using rustup.

git clone https://github.com/atuinsh/atuin.git
cd atuin/crates/atuin
cargo install --path .

Please be advised

If you choose to manually install Atuin rather than using the recommended installation script, merely installing the binary is not sufficient, you should also set up the shell plugin.

---

Installing the 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! After installing, remember to restart your shell.

zsh

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

zinit

zinit load atuinsh/atuin

Antigen

antigen bundle atuinsh/atuin@main

bash

ble.sh

Atuin works best in bash when using ble.sh.

With ble.sh installed, just add atuin to your .bashrc

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

bash-preexec

Bash-preexec can also be used, but you may experience some minor problems with the recorded duration and exit status of some commands.

Please note

bash-preexec currently has an issue where it will stop honoring ignorespace. While Atuin will ignore commands prefixed with whitespace, they may still end up in your bash history. Please check your configuration! All other shells do not have this issue.

To use bash-preexec, download and initialize it

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

fish

Add

atuin init fish | source

to your is-interactive block in your ~/.config/fish/config.fish file

Nushell

Run in Nushell:

mkdir ~/.local/share/atuin/
atuin init nu | save ~/.local/share/atuin/init.nu

Add to config.nu:

source ~/.local/share/atuin/init.nu

xonsh

Add

execx($(atuin init xonsh))

to the end of your ~/.xonshrc

Upgrade

In order to upgrade Atuin, just run the installation script again! It won’t add to your shell config more than once, so is safe to re-run.

Uninstall

If you’d like to uninstall Atuin, please check out this page.