atuin README

The project's README from github.com/atuinsh/atuin. As one markdown file: README.md.

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

magical shell history


CodSpeed

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

Documentation

Supported platforms

Atuin supports zsh, bash, fish, nushell, xonsh, and PowerShell. See Supported platforms for the full matrix and what each tier means.

Community

Forum

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

IRC

We're also available via #atuin on libera.chat

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 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.

Related projects

Please open a PR for any others!

Contributors

Made with contrib.rocks.

atuin (atuinsh/atuin)

Searching Database…

32K ·GitHub
Что это такое?Atuin заменяет историю вашей командной оболочки на базу данных SQLite, записывает для каждой команды дополнительный контекст и добавляет полноэкранный интерактивный поиск — с опциональной полностью зашифрованной синхронизацией истории между машинами.
Это плагин внутри моей оболочки или отдельная программа?Это самостоятельный CLI на Rust, который встраивается в вашу оболочку: он переназначает ctrl-r и стрелку вверх (настраивается) на полноэкранный поиск по истории, при этом старый файл истории остаётся нетронутым.
Как его запустить?Установите бинарник atuin (в официальной документации по установке описана каждая платформа), затем выполните настройку для своей оболочки, чтобы ctrl-r и стрелка вверх открывали поиск Atuin. В документации есть разделы Quickstart, Import history и Basic usage.
С какими оболочками он работает?Поддерживаются zsh, bash, fish, nushell, xonsh и PowerShell, для каждой — свои хуки настройки; в документации есть полная таблица совместимости.
В bash всё работает так же?Не совсем: поддержка bash реализована через bash-preexec, который предоставляет нужные хуки, а у bash-preexec есть известные ограничения — в других оболочках интеграция более прямая.
Синхронизация вообще обязательна?Нет — можно пользоваться сервером автора, поднять свой или вовсе обойтись без синхронизации; в любом случае история хранится локально в SQLite.
Может ли сервер синхронизации прочитать мою историю?Нет. Вся синхронизация истории зашифрована, так что на сервере хранится только шифротекст — автор заявляет, что даже при желании не смог бы получить доступ к вашим данным.
Что записывается для каждой команды, кроме самой команды?Код возврата, рабочая директория, имя хоста, сессия, длительность и время — всё это логируется, а ещё на этих данных строятся статистики вроде «самой частой команды».
Что я могу сделать с найденным результатом в поиске?Нажмите Enter, чтобы выполнить команду, или Tab, чтобы сначала отредактировать её. Alt-backslash быстро перескакивает к предыдущим элементам, а ctrl-r переключает режимы фильтрации.
Можно искать только в текущей сессии или директории, а не везде?Да — ctrl-r переключает режимы фильтрации, поэтому поиск можно ограничить текущей сессией, текущей директорией или всей историей.
Не потеряю ли я свою существующую историю при переходе на Atuin?Нет — старый файл истории не заменяется, а в документации есть руководство по импорту, которое поможет перенести прошлую историю в базу SQLite.
Which topics is it in?history, fish, zsh, sync, powershell, bash, search, tui, encryption, shell, sqlite, rust
Creator
atuinsh
Size
80.3 MB
Stars
32K
Age
6y
Commits · 90 Days