# Getting Started

Atuin captures your activity in the terminal including all the commands you
ran, optionally with the command output, the AI threads you had with your
agents.

You can either keep this data E2E-encrypted, or you can choose to share it
inside or outside your team.

## Install

Running our official install script will get you started:

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

This installer will prompt you to set Atuin up:

<VHSTape title="atuin setup finds 230 commands in the zsh history. It keeps shell history on for zsh and bash, turns sync off, imports the 230 commands, and suggests Ctrl-R and the up arrow in a new terminal.">
  Set Width 1376
  Set Height 940
  # A machine that Atuin isn't set up on yet; see vhs/shell/.zshrc.
  Env DOCS_NEW_USER "1"
  Sleep 500ms
  Type "atuin setup"
  Enter
  Wait+Screen@30s /Continue/
  Sleep 2s
  Down@400ms 4
  Enter
  Wait+Screen@10s /Where should/
  Sleep 1.5s
  # Atuin Cloud would sign in through a browser.
  Down@400ms 2
  Enter
  Sleep 800ms
  Down
  Enter
  Wait+Screen@10s /already here/
  Sleep 1.5s
  Down
  Enter
  Wait+Screen@1m /is ready/
  Sleep 3s
</VHSTape>

:::caution[Restart your shell]

Setup finishes by asking you to open a new terminal, which loads Atuin. **Do not
skip this step!**

:::

At this point Atuin is recording new commands. Depending on how you configured
Atuin, press <kbd>Ctrl</kbd>+<kbd>R</kbd> or the <kbd>↑</kbd> arrow to search
your commands.

Setup imports your current shell's history file.

You can run `atuin setup` again at any time to change what it set up.

<VHSTape title="A new command runs, and the up arrow finds it at the bottom of Atuin's search. Then Ctrl-R searches for kubectl, and Tab puts the selected command on the command line.">
  Sleep 500ms
  Type `echo "hello from atuin"`
  Enter
  Sleep 1s
  Up
  Sleep 2s
  Escape
  Sleep 800ms
  Ctrl+R
  Sleep 1s
  Type "kubectl"
  Sleep 1.5s
  Up
  Sleep 700ms
  Tab
  Sleep 2s
</VHSTape>

## Make it yours

Once you're up and running:

- [Basic usage](/guide/basic-usage/) — what Atuin records, and how to drive the TUI
- [Filter and search modes](/guide/advanced-usage/) — narrow searches to this
  directory, this machine, or this session
- [Key bindings](/configuration/key-binding/) — including how to
  [disable the up arrow binding](/configuration/key-binding/#disable-up-arrow)
  with `atuin setup --only --no-up-arrow` if it isn't for you
- [Configuration reference](/reference/config/) — every setting, including an
  [inline window](/reference/config/general/#inline_height) instead of full screen

## Atuin Web

Atuin hosts both a sync server, and _Atuin Hub_. _Atuin Hub_ is Atuin's web
platform. Atuin Hub enables you to see your Atuin data in the browser, share
your data with anyone, and allow your team to see each other's context.

TODO 20s DEMO

:::note

Atuin Hub features require that you enable _Atuin Hub_ by running
`atuin setup --hub`.

<VHSTape title="atuin setup --hub on its Hub step: Atuin Hub is always enabled, uploading all your threads, and isn't end-to-end encrypted.">
  Set FontSize 20
  Set Height 600
  # A machine that Atuin isn't set up on yet; see vhs/shell/.zshrc.
  Env DOCS_NEW_USER "1"
  Sleep 500ms
  Type "atuin setup --hub"
  Enter
  Wait+Screen@30s /Continue/
  Sleep 1s
  Down@300ms 4
  Enter
  Wait+Screen@10s /Where should/
  Sleep 1.5s
  Down@300ms 3
  Enter
  Wait+Screen@10s /Atuin Hub allows/
  Sleep 3s
  Screenshot
  # Atuin Cloud would sign in through a browser, so setup stops here.
  Hide
  Ctrl+C
  Sleep 500ms
</VHSTape>

Enabling _Atuin Hub_ in `atuin setup --hub` causes your data to be
uploaded in E2E mode, as well as only encrypted-at-rest. For more details, see
[Data & Privacy](/guide/data-privacy/).

:::

:::caution[E2E Encryption]

You can use _Atuin Web_ without _Atuin Hub._ Atuin's sync server is fully
E2E encrypted, and if you do not enable _Atuin Hub_, then Atuin Web will
never be able to see your data.

:::

To get started with Atuin Hub, create an account on
[Atuin Hub](https://atuin.sh/), and connect it with your Atuin by running
`atuin login`:

```sh
atuin login
```

Depending on your `atuin setup` options, Atuin will either:

- Upload all your data to Atuin Hub.
- Upload only data in [workspaces](/hub/threads/#workspaces) with `.atuin.lua` files to Atuin Hub.
- Completely disable Atuin Hub support. Atuin Web acts as a sync server.

You can go to `https://atuin.sh/threads` to see all your updated threads.

## Help

Atuin has an awesome community. Open a topic on the
[:discourse: forum](https://forum.atuin.sh), join our [:discord:
Discord](https://discord.gg/Fq8bJSKPHh), tweet at us on [:twitter:
Twitter](https://twitter.com/atuinsh) or chat with us on [:bluesky:
Bluesky](https://bluesky.com/atuin) or file an
[issue](https://github.com/atuinsh/atuin/issues).