Magical shell history
Find a file
Lucas Trzesniewski 8a010fed33
Some checks failed
Codespell / Check for spelling errors (push) Has been cancelled
Shellcheck / shellcheck (push) Has been cancelled
build-docker / publish_x86 (push) Has been cancelled
Rust / format (push) Has been cancelled
build-docker / publish_aarch64 (push) Has been cancelled
Install / install (macos-14) (push) Has been cancelled
Install / install (ubuntu-latest) (push) Has been cancelled
Nix / check (push) Has been cancelled
Rust / build (macos-14) (push) Has been cancelled
Rust / unit-test (macos-14) (push) Has been cancelled
Rust / unit-test (ubuntu-latest) (push) Has been cancelled
Rust / unit-test (windows-latest) (push) Has been cancelled
Rust / check (macos-14) (push) Has been cancelled
Rust / check (ubuntu-latest) (push) Has been cancelled
Nix / build-test (push) Has been cancelled
Rust / build (ubuntu-latest) (push) Has been cancelled
Rust / build (windows-latest) (push) Has been cancelled
Rust / cross-compile (x86_64-unknown-illumos) (push) Has been cancelled
Rust / check (windows-latest) (push) Has been cancelled
Rust / integration-test (push) Has been cancelled
Rust / clippy (push) Has been cancelled
build-docker / publish_manifest (push) Has been cancelled
fix(powershell): run atuin history end in the background (#3034)
This runs `atuin history end` in the background, since it could delay
the next prompt when syncing.

Sorry I didn't realize this command could be slow (I currently don't use
sync).

I went for the .NET [`Process`
class](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.process),
which is not pretty, but the other solutions I thought about all had
their own issues (`Start-Process` needs a file to redirect the output so
you can't just ignore it, `Start-Job` creates job objects that will
linger, `&` does the same but doesn't work on PS 5.1, ...). I'm
surprised I couldn't find a nice way to do the equivalent of `command &
>/dev/null` in PowerShell. 😕

This replaces #3033

## Checks
- [x] I am happy for maintainers to push small adjustments to this PR,
to speed up the review cycle
- [x] I have checked that there are no existing pull requests for the
same thing
2025-12-22 22:22:06 +00:00
.cargo chore: add audit config, ignore RUSTSEC-2023-0071 (#2126) 2024-06-13 12:37:43 +01:00
.github ci: fix github action syntax for variables (#2998) 2025-12-03 15:14:21 -08:00
crates fix(powershell): run atuin history end in the background (#3034) 2025-12-22 22:22:06 +00:00
docs docs: Migrate docs from separate repo to docs subfolder (#3018) 2025-12-12 14:47:24 -08:00
docs-i18n docs: Migrate docs from separate repo to docs subfolder (#3018) 2025-12-12 14:47:24 -08: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 build: remove legacy Apple SDK frameworks (#2885) 2025-09-09 19:35:41 -07:00
atuin.plugin.zsh run shellcheck (#97) 2021-05-14 08:31:15 +01:00
Cargo.lock chore(deps): Update some packages realated to ring and aws-lc (#2991) 2025-11-17 20:04:24 -08:00
Cargo.toml chore(deps): Update some packages realated to ring and aws-lc (#2991) 2025-11-17 20:04:24 -08:00
CHANGELOG.md chore: update changelog 2025-10-21 14:38:08 -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 ci: add Windows builds, second try (#2966) 2025-10-31 11:36:06 -07:00
docker-compose.yml fix: docker compose link (#2914) 2025-09-26 10:49:51 -07:00
Dockerfile chore(deps): bump lukemathwalker/cargo-chef from latest-rust-1.91.0-slim-bookworm to latest-rust-1.91.1-slim-bookworm (#2995) 2025-11-17 19:27:36 -08:00
flake.lock chore: update to Rust 1.90 (#2916) 2025-09-26 10:46:49 -07:00
flake.nix build(nix): prevent deprecation warning on evaluation (#3006) 2025-12-02 16:52:14 -08:00
install.sh chore: Add Atuin Desktop information to install script 2025-11-10 14:49:41 -08: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 chore: update to rust 1.91 (#2981) 2025-11-06 16:16:43 -08: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.