Skip to content

Getting Started

This guide walks through setting Atuin up properly, one step at a time. If you just want the commands, the quickstart on the home page has them.

Setting Atuin up takes four steps, and only the first is required. The install script runs atuin setup, which walks you through the first three:

  1. Install Atuin and its shell plugin
  2. Import your existing history
  3. Set up sync, if you want your history on more than one machine
  4. Learn the TUI

1. Install

The install script installs the binary, then runs atuin setup, which installs the shell plugin and walks you through the rest:

curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh

Then restart your shell. Prefer a package manager, or want to install the pieces yourself? See Installation. After installing the binary another way, run atuin setup to do the rest.

At this point Atuin is recording new commands. Press Ctrl+R or the Up arrow to search them.

2. Import your existing history

Atuin only records commands run after it's installed, so setup brings the old ones in. Setup imports your current shell's history file, which stays untouched — your shell keeps writing to it as usual.

If you skipped the import, or your sync account already had history, import this machine's history with:

atuin import auto

See Import existing history for importing from a specific shell or a non-default file.

3. Set up sync (optional)

Sync backs your history up and shares it between machines, end-to-end encrypted. You can use our server or host your own.

Setup offers to sign you in to Atuin Cloud. If you skipped sync, sign in through your browser with:

atuin setup --sync cloud

Atuin encrypts your history with a key that it keeps on this machine. Run atuin key to show the key. Save the key somewhere safe — you'll need it to log in on any other machine, and it can't be recovered. See Setting up sync for the details, including logging in elsewhere.

Skipping this step is fine. Your history stays on this machine, not backed up and not synchronized.

4. Make it yours

Once you're up and running:

Getting help

Open a topic on the forum, join our Discord, or file an issue. Running atuin doctor collects the information we'll ask for.