Magical shell history
Find a file
dependabot[bot] 29576ac6c7
Some checks are pending
Install / install (ubuntu-latest) (push) Waiting to run
Nix / check (push) Waiting to run
Nix / build-test (push) Waiting to run
Codespell / Check for spelling errors (push) Waiting to run
build-docker / publish_x86 (push) Waiting to run
build-docker / publish_aarch64 (push) Waiting to run
build-docker / publish_manifest (push) Blocked by required conditions
Install / install (macos-14) (push) Waiting to run
Rust / build (macos-14) (push) Waiting to run
Rust / build (ubuntu-latest) (push) Waiting to run
Rust / cross-compile (x86_64-unknown-illumos) (push) Waiting to run
Rust / unit-test (macos-14) (push) Waiting to run
Rust / unit-test (ubuntu-latest) (push) Waiting to run
Rust / check (macos-14) (push) Waiting to run
Rust / check (ubuntu-latest) (push) Waiting to run
Rust / integration-test (push) Waiting to run
Rust / clippy (push) Waiting to run
Rust / format (push) Waiting to run
Shellcheck / shellcheck (push) Waiting to run
chore(deps): bump debian (#2811)
Bumps debian from bookworm-20250610-slim to bookworm-20250630-slim.

---
updated-dependencies:
- dependency-name: debian
  dependency-version: bookworm-20250630-slim
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-07-07 13:40:06 +01:00
.cargo chore: add audit config, ignore RUSTSEC-2023-0071 (#2126) 2024-06-13 12:37:43 +01:00
.github chore(ci): Install toolchain that matches rust-toolchain.toml (#2759) 2025-05-14 20:28:05 -07:00
crates fix: refuse "--dupkeep 0" (#2807) 2025-07-03 16:35:18 +01:00
docs ci: use native github arm64 runner (#2690) 2025-04-09 15:48:51 +01:00
k8s feat(health): add health check endpoint at /healthz (#2549) 2025-03-09 21:43:27 +00:00
systemd chore: Add Systemd config for self-hosted server (#1879) 2024-06-03 11:20:15 +01:00
.codespellrc chore(release): prepare for release 18.5.0-beta.1 (#2622) 2025-03-11 18:16:19 +00:00
.dockerignore Optimise docker (#34) 2021-04-14 17:40:50 +00:00
.gitattributes fix: sql files checksums (#2601) 2025-03-03 12:02:35 +00:00
.gitignore feat: Add sqlite server support for self-hosting (#2770) 2025-06-23 12:31:55 +01:00
.mailmap chore(release): prepare for release v18.4.0-beta.2 (#2287) 2024-07-16 15:19:33 +01:00
.rustfmt.toml ignore JetBrains IDEs, tidy-up imports (#348) 2022-04-28 18:53:59 +01:00
atuin.nix chore(build): compile protobufs with protox (#2122) 2024-06-12 16:45:38 +01:00
atuin.plugin.zsh run shellcheck (#97) 2021-05-14 08:31:15 +01:00
Cargo.lock feat: Add sqlite server support for self-hosting (#2770) 2025-06-23 12:31:55 +01:00
Cargo.toml chore(deps): bump tower from 0.4.13 to 0.5.2 (#2734) 2025-05-08 14:44:13 -07:00
CHANGELOG.md chore(release): prepare for release 18.6.0 (#2740) 2025-05-06 16:18:21 -07:00
cliff.toml chore(release): prepare for release v18.4.0-beta.1 (#2195) 2024-06-25 12:35:12 +01:00
CODE_OF_CONDUCT.md Add code of conduct (#281) 2022-03-17 21:43:54 +00:00
CONTRIBUTING.md chore: Allow setting script DB path (#2750) 2025-05-13 08:29:04 -07:00
CONTRIBUTORS chore(release): prepare for release 18.6.0 (#2740) 2025-05-06 16:18:21 -07:00
default.nix nix: add flake-compat (#743) 2023-03-01 19:51:31 +00:00
demo.gif Release v0.7.0 (#103) 2021-05-10 21:28:07 +01:00
deny.toml replace chrono with time (#806) 2023-09-11 09:26:05 +01:00
dist-workspace.toml fix: switch to astral cargo-dist (#2687) 2025-04-09 11:58:56 +01:00
docker-compose.yml docs: use db name env variable also in uri (#1840) 2024-03-08 09:02:53 +00:00
Dockerfile chore(deps): bump debian (#2811) 2025-07-07 13:40:06 +01:00
flake.lock build(nix): bump flake.lock (#2637) 2025-03-19 13:38:01 +00:00
flake.nix Revert "Revert "chore: update to rust 1.86 (#2666)" (#2667)" (#2676) 2025-04-07 13:04:18 +01:00
install.sh fixes #2603: support fish plugin in install script (#2604) 2025-03-09 22:36:44 +00:00
LICENSE Create LICENSE 2021-02-14 16:22:25 +00:00
README.md ci: use native github arm64 runner (#2690) 2025-04-09 15:48:51 +01:00
rust-toolchain.toml Revert "Revert "chore: update to rust 1.86 (#2666)" (#2667)" (#2676) 2025-04-07 13:04:18 +01:00

Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'

magical shell history


English | 简体中文

Atuin replaces your existing shell history with a SQLite database, and records additional context for your commands. Additionally, it provides optional and fully encrypted synchronisation of your history between machines, via an Atuin server.

animated

exit code, duration, time and command shown

As well as the search UI, it can do things like this:

# search for all successful `make` commands, recorded after 3pm yesterday
atuin search --exit 0 --after "yesterday 3pm" make

You may use either the server I host, or host your own! Or just don't use sync at all. As all history sync is encrypted, I couldn't access your data even if I wanted to. And I really don't want to.

Features

  • rebind ctrl-r and up (configurable) to a full screen history search UI
  • store shell history in a sqlite database
  • back up and sync encrypted shell history
  • the same history across terminals, across sessions, and across machines
  • log exit code, cwd, hostname, session, command duration, etc
  • calculate statistics such as "most used command"
  • old history file is not replaced
  • quick-jump to previous items with Alt-<num>
  • switch filter modes via ctrl-r; search history just from the current session, directory, or globally
  • enter to execute a command, tab to edit

Documentation

Supported Shells

  • zsh
  • bash
  • fish
  • nushell
  • xonsh

Community

Forum

Atuin has a community forum, please ask here for help and support: https://forum.atuin.sh/

Discord

Atuin also has a community Discord, available here

Quickstart

This will sign you up for the Atuin Cloud sync server. Everything is end-to-end encrypted, so your secrets are safe!

Read more in the docs for an offline setup, self hosted server, and more.

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

atuin register -u <USERNAME> -e <EMAIL>
atuin import auto
atuin sync

Then restart your shell!

Note

For Bash users: The above sets up bash-preexec for necessary hooks, but bash-preexec has limitations. For details, please see the Bash section of the shell plugin documentation.

Security

If you find any security issues, we'd appreciate it if you could alert ellie@atuin.sh

Contributors

Made with contrib.rocks.