magical shell history

exit code, duration, time and command shown

-e 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](https://atuin.sh/docs/config/#update_check) `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](#shell-plugin) ### With cargo It's best to use [rustup](https://rustup.rs/) to get setup with a Rust toolchain, then you can run: ``` cargo install atuin ``` And then follow [the shell setup](#shell-plugin) ### Homebrew ``` brew install atuin ``` And then follow [the shell setup](#shell-plugin) ### MacPorts Atuin is also available in [MacPorts](https://ports.macports.org/port/atuin/) ``` sudo port install atuin ``` And then follow [the shell setup](#shell-plugin) ### 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](https://github.com/NixOS/nixpkgs): ``` nix-env -f '' -iA atuin ``` And then follow [the shell setup](#shell-plugin) ### Pacman Atuin is available in the Arch Linux [[extra] repository](https://archlinux.org/packages/extra/x86_64/atuin/): ``` pacman -S atuin ``` And then follow [the shell setup](#shell-plugin) ### Termux Atuin is available in the Termux package repository: ``` pkg install atuin ``` And then follow [the shell setup](#shell-plugin) ### From source ``` git clone https://github.com/atuinsh/atuin.git cd atuin/atuin cargo install --path . ``` And then follow [the shell setup](#shell-plugin) ## 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 ```sh zinit load atuinsh/atuin ``` #### Antigen ```sh antigen bundle atuinsh/atuin@main ``` ### bash #### [ble.sh](https://github.com/akinomyoga/ble.sh) Atuin works best in bash when using [ble.sh](https://github.com/akinomyoga/ble.sh). With ble.sh installed, just add atuin to your .bashrc ```bash echo 'eval "$(atuin init bash)"' >> ~/.bashrc ``` #### [bash-preexec](https://github.com/rcaloras/bash-preexec) [Bash-preexec](https://github.com/rcaloras/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 ```bash 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 ```bash 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](https://contrib.rocks). [English]: ./README.md [简体中文]: ./docs/zh-CN/README.md