7bc6ccdd70
* feat: rework record sync for improved reliability So, to tell a story 1. We introduced the record sync, intended to be the new algorithm to sync history. 2. On top of this, I added the KV store. This was intended as a simple test of the record sync, and to see if people wanted that sort of functionality 3. History remained syncing via the old means, as while it had issues it worked more-or-less OK. And we are aware of its flaws 4. If KV syncing worked ok, history would be moved across KV syncing ran ok for 6mo or so, so I started to move across history. For several weeks, I ran a local fork of Atuin + the server that synced via records instead. The record store maintained ordering via a linked list, which was a mistake. It performed well in testing, but was really difficult to debug and reason about. So when a few small sync issues occured, they took an extremely long time to debug. This PR is huge, which I regret. It involves replacing the "parent" relationship that records once had (pointing to the previous record) with a simple index (generally referred to as idx). This also means we had to change the recordindex, which referenced "tails". Tails were the last item in the chain. Now that we use an "array" vs linked list, that logic was also replaced. And is much simpler :D Same for the queries that act on this data. ---- This isn't final - we still need to add 1. Proper server/client error handling, which has been lacking for a while 2. The actual history implementation on top This exists in a branch, just without deletions. Won't be much to add that, I just don't want to make this any larger than it already is The _only_ caveat here is that we basically lose data synced via the old record store. This is the KV data from before. It hasn't been deleted or anything, just no longer hooked up. So it's totally possible to write a migration script. I just need to do that. * update .gitignore * use correct endpoint * fix for stores with length of 1 * use create/delete enum for history store * lint, remove unneeded host_id * remove prints * add command to import old history * add enable/disable switch for record sync * add record sync to auto sync * satisfy the almighty clippy * remove file that I did not mean to commit * feedback |
||
---|---|---|
.github | ||
atuin | ||
atuin-client | ||
atuin-common | ||
atuin-server | ||
atuin-server-database | ||
atuin-server-postgres | ||
docs | ||
k8s | ||
.dockerignore | ||
.gitignore | ||
.mailmap | ||
.rustfmt.toml | ||
atuin.nix | ||
atuin.plugin.zsh | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
cliff.toml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
CONTRIBUTORS | ||
default.nix | ||
demo.gif | ||
deny.toml | ||
docker-compose.yml | ||
Dockerfile | ||
flake.lock | ||
flake.nix | ||
install.sh | ||
LICENSE | ||
README.md |
magical shell history
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.
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
andup
(configurable) to a full screen history search UI - store shell history in a sqlite database
- backup 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
Documentation
- Quickstart
- Install
- Import
- Configuration
- Searching history
- Cloud history sync
- History stats
- Self host Atuin server
- Key binding
- Shell completions
Supported Shells
- zsh
- bash
- fish
- nushell
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
With the default sync server
This will sign you up for the default sync server, hosted by me. Everything is end-to-end encrypted, so your secrets are safe!
Read more below for offline-only usage, or for hosting your own server.
# bash/zsh/etc
bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)
# fish
bash (curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh | psub)
atuin register -u <USERNAME> -e <EMAIL>
atuin import auto
atuin sync
Then restart your shell!
Opt-in to activity graph
Alongside the hosted Atuin server, there is also a service which generates activity graphs for your shell history! These are inspired by the GitHub graph.
For example, here is mine:
If you wish to get your own, after signing up for the sync server, run this
curl https://api.atuin.sh/enable -d $(cat ~/.local/share/atuin/session)
The response includes the URL to your graph. Feel free to share and/or embed this URL, the token is not a secret, and simply prevents user enumeration.
Offline only (no sync)
bash <(curl https://raw.githubusercontent.com/atuinsh/atuin/main/install.sh)
atuin import auto
By default, Atuin will check for updates. You can disable update checks by modifying config.toml
.
Then restart your shell!
Install
Script (recommended)
The install script will help you through the setup, ensuring your shell is properly configured. It will also use one of the below methods, preferring the system package manager where possible (pacman, homebrew, etc etc).
# do not run this as root, root will be asked for if required
bash <(curl https://raw.githubusercontent.com/atuinsh/atuin/main/install.sh)
And then follow the shell setup
With cargo
It's best to use rustup to get setup with a Rust toolchain, then you can run:
cargo install atuin
And then follow the shell setup
Homebrew
brew install atuin
And then follow the shell setup
MacPorts
Atuin is also available in MacPorts
sudo port install atuin
And then follow the shell setup
Nix
This repository is a flake, and can be installed using nix profile
:
nix profile install "github:atuinsh/atuin"
Atuin is also available in nixpkgs:
nix-env -f '<nixpkgs>' -iA atuin
And then follow the shell setup
Pacman
Atuin is available in the Arch Linux [extra] repository:
pacman -S atuin
And then follow the shell setup
Xbps
Atuin is available in the Void Linux repository:
sudo xbps-install atuin
And then follow the shell setup
Termux
Atuin is available in the Termux package repository:
pkg install atuin
And then follow the shell setup
From source
git clone https://github.com/atuinsh/atuin.git
cd atuin/atuin
cargo install --path .
And then follow the shell setup
Shell plugin
Once the binary is installed, the shell plugin requires installing. If you use the install script, this should all be done for you! After installing, remember to restart your shell.
zsh
echo 'eval "$(atuin init zsh)"' >> ~/.zshrc
Zinit
zinit load atuinsh/atuin
Antigen
antigen bundle atuinsh/atuin@main
bash
ble.sh
Atuin works best in bash when using ble.sh >= 0.4.
With ble.sh (>= 0.4) installed, just add atuin to your .bashrc
echo 'eval "$(atuin init bash)"' >> ~/.bashrc
Please make sure that the above line comes after sourcing ble.sh so atuin knows the presence of ble.sh.
bash-preexec
Bash-preexec can also be used, but you may experience some minor problems with the recorded duration and exit status of some commands.
To use bash-preexec, download and initialize it
curl https://raw.githubusercontent.com/rcaloras/bash-preexec/master/bash-preexec.sh -o ~/.bash-preexec.sh
echo '[[ -f ~/.bash-preexec.sh ]] && source ~/.bash-preexec.sh' >> ~/.bashrc
Then setup Atuin
echo 'eval "$(atuin init bash)"' >> ~/.bashrc
PLEASE NOTE
bash-preexec currently has an issue where it will stop honoring ignorespace
. While Atuin will ignore commands prefixed with whitespace, they may still end up in your bash history. Please check your configuration! All other shells do not have this issue.
fish
Add
atuin init fish | source
to your is-interactive
block in your ~/.config/fish/config.fish
file
Nushell
Run in Nushell:
mkdir ~/.local/share/atuin/
atuin init nu | save ~/.local/share/atuin/init.nu
Add to config.nu
:
source ~/.local/share/atuin/init.nu
Contributors
Made with contrib.rocks.