Installation
Simply run the installation script and that will walk you through installing Atuin:
curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | shAfter installing, the script runs atuin setup. Setup hooks Atuin into your
shells, imports your shell history, and offers to set up a sync account.
This will install a binary to ~/.atuin/bin.
Upgrade
Section titled “Upgrade”Run atuin update, and if that command isn’t available, run the install script
again.
Moving to ~/.atuin
Section titled “Moving to ~/.atuin”Older versions of Atuin stored data in ~/.config/atuin (or
$XDG_CONFIG_HOME/atuin) and ~/.local/share/atuin (or
$XDG_DATA_HOME/atuin). While ATUIN_HOME is unset, Atuin still looks for
data in the old locations when it doesn’t find it in ~/.atuin, so an older
install keeps working as it is.
To move to the new layout, run these commands in Bash, Zsh or fish. Adjust the
paths if you set XDG_CONFIG_HOME or XDG_DATA_HOME.
Stop the daemon, and turn autostart off for now:
atuin config set daemon.autostart falseatuin daemon stopMake sure ~/.atuin exists:
mkdir -p ~/.atuinCheck whether you have any AI-related files in ~/.atuin:
ls ~/.atuin | grep -Fxe permissions.ai.toml -e skillsIf you do, follow this section first:
Migrating home-scoped AI config
In older installs, permissions.ai.toml and skills in ~/.atuin apply to
your home directory. In newer installs, they apply globally. Whether
~/.atuin/config.toml exists decides which: if it does, these items are
global.
Before you move your config.toml to ~/.atuin, review the AI files already
in ~/.atuin, especially permissions.ai.toml. Leave anything you’re fine
with applying globally, which is close to applying to your whole home directory
anyway. Delete anything else, or move it into ~/subdir/.atuin/ for each
subdirectory it should apply to.
Then check whether any AI items appear in both ~/.atuin and
~/.config/atuin:
ls ~/.atuin ~/.config/atuin | grep -Fxe permissions.ai.toml -e skills | \ sort | uniq -dThose in ~/.atuin shadow those in ~/.config/atuin. Merge any you still want
into ~/.atuin.
Move your config:
cd ~/.config/atuin && mv -n $(ls | grep -Fxe config.toml -e server.toml \ -e themes -e skills -e permissions.ai.toml) ~/.atuin/Move your data:
[ -e ~/.atuin/data ] && echo 'error: destination exists' || \ mv -n ~/.local/share/atuin ~/.atuin/dataTurn daemon autostart back on, if you had it on before:
atuin config set daemon.autostart trueUninstall
Section titled “Uninstall”If you’d like to uninstall Atuin, please check out the uninstall page.
TODO avoid this section
Manual Installation
Section titled “Manual Installation”We do not recommend using alternative installation methods, but we try our best to support them:
Atuin requires a recent Rust toolchain. Distribution package managers often ship an older Rust, so it’s best to use rustup to set up an up-to-date toolchain, then you can run:
cargo install atuin --lockedbrew install atuinAtuin is also available in MacPorts:
sudo port install atuinAtuin is also installable using mise:
mise use -g atuin@latestThis repository is a flake, and can be installed using nix profile:
nix profile install "github:atuinsh/atuin"Linux builds of main are cached on Cachix. Run
cachix use atuin first to download them instead of building from source.
Atuin is available in the Arch Linux extra repository:
pacman -S atuinAtuin is available in the Termux package repository:
pkg install atuinAtuin is installable from github-releases directly:
# line 1: `atuin` binary as command, from github release, only look at .tar.gz files (excluding server), use the `atuin` file from the extracted archive# line 2: setup at clone(create init.zsh, completion)# line 3: pull behavior same as clone, source init.zshzinit ice as"command" from"gh-r" bpick"atuin-*.tar.gz~*server*" mv"atuin*/atuin -> atuin" \ atclone"./atuin init zsh > init.zsh; ./atuin gen-completions --shell zsh > _atuin" \ atpull"%atclone" src"init.zsh"zinit light atuinsh/atuinAtuin is available on WinGet:
winget install -e Atuinsh.AtuinThen, in a new shell, run atuin setup. Setup adds Atuin to the profiles of
both PowerShell 7 and Windows PowerShell.
Atuin builds on the latest stable version of Rust, and we make no
promises regarding older versions. The minimum supported version is set by
rust-version in the workspace
Cargo.toml
(currently 1.98.0). We recommend using rustup.
git clone https://github.com/atuinsh/atuin.gitcd atuincargo install --path crates/atuin --lockedInstalling the shell plugin
Section titled “Installing the shell plugin”Once the binary is installed, the shell plugin needs installing. For zsh,
bash, fish, and PowerShell, atuin setup installs it for you, and the install
script runs atuin setup. After installing, remember to restart your shell.
To hook only some shells and change nothing else, pass --only and name the
shells with --shells. For example, this command hooks zsh and fish:
atuin setup --only --shell-history --shells zsh,fishRun setup, which adds eval "$(atuin init zsh)" to $ZDOTDIR/.zshrc, or to
~/.zshrc when ZDOTDIR isn’t set:
atuin setup --only --shell-history --shells zshIf you use a plugin manager, load Atuin with it instead.
# if you _only_ want to install the shell-plugin, do this; otherwise look above for a "everything via zinit" solutionzinit load atuinsh/atuinantigen bundle atuinsh/atuin@mainantidote install atuinsh/atuinAtuin works best in bash when using ble.sh >= 0.4.
With ble.sh (>= 0.4) installed and loaded in ~/.bashrc, run setup, which adds
eval "$(atuin init bash)" to the end of your ~/.bashrc:
atuin setup --only --shell-history --shells bashbash-preexec can also be used, but you may experience some minor problems with the recorded duration and exit status of some commands.
As of Atuin 18.18.0, atuin init bash will automatically load bash-preexec if no other
preexec backend has been loaded (ble.sh or an external copy of bash-preexec). To use the
built-in copy, run setup, which adds eval "$(atuin init bash)" to your ~/.bashrc:
atuin setup --only --shell-history --shells bashTo disable the built-in copy, pass ATUIN_NO_BUILTIN_PREEXEC=1 to atuin init in your
~/.bashrc, e.g.:
eval "$(ATUIN_NO_BUILTIN_PREEXEC=1 atuin init bash)"If you prefer, you can also download and install bash-preexec separately:
curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec.sh -o ~/.bash-preexec.shecho '[[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh' >> ~/.bashrcThen run setup, which adds Atuin to the end of your ~/.bashrc, after
bash-preexec:
atuin setup --only --shell-history --shells bashRun setup, which adds an is-interactive block that runs
atuin init fish | source to your ~/.config/fish/config.fish file:
atuin setup --only --shell-history --shells fishRun in Nushell:
mkdir ~/.atuin/atuin init nu | save ~/.atuin/init.nuAdd to config.nu:
source ~/.atuin/init.nuOptional: Atuin pty-proxy
pty-proxy is a lightweight pty proxy that renders the Atuin popup over your previous output, restoring it when closed — no clearing, no fullscreen. To use pty-proxy with Nushell, generate the init script:
mkdir ~/.atuin/atuin pty-proxy init nu | save -f ~/.atuin/pty-proxy-init.nuThen source it as early as possible in your config.nu, before
the regular atuin init:
source ~/.atuin/pty-proxy-init.nusource ~/.atuin/init.nuNushell’s source command requires a static file path, so you must
pre-generate both files.
Add
execx($(atuin init xonsh))to the end of your ~/.xonshrc
Run setup, which adds atuin init powershell | Out-String | Invoke-Expression
to the end of your PowerShell profile:
atuin setup --only --shell-history --shells powershellOn Windows, setup writes to the profiles of both PowerShell 7 and Windows
PowerShell, in your Documents folder. Elsewhere, setup writes to
~/.config/powershell/Microsoft.PowerShell_profile.ps1.