a127408e93
* run shellcheck
* Update .github/workflows/shellcheck.yml
Co-authored-by: Conrad Ludgate <oon@conradludgate.com>
* shellcheck fixes in which i am highly confident
* shellcheck fixes in which I am less confident - not executing this is fine, right?
* SC2155
In src/shell/atuin.bash line 1:
export ATUIN_SESSION=$(atuin uuid)
^-----------^ SC2155: Declare and assign separately to avoid masking return values.
* shellcheck doesn't support zsh, per https://github.com/koalaman/shellcheck/wiki/SC1071
* yaml fix
* gotta checkout our code, too
* yaml fix
* action spelling
* exclude .zsh
* Shellcheck doesn't support zsh, per
https://github.com/koalaman/shellcheck/wiki/SC1071, and the ignore: param
in ludeeus/action-shellcheck only supports _directories_, not _files_.
So instead, we manually add any error the shellcheck step finds in the
file to the above line ...
* comment all the ignores
* Update src/shell/atuin.bash
Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
* new zsh plugin shellcheck errors
* new zsh plugin shellcheck errors, pt 2
Co-authored-by: Conrad Ludgate <oon@conradludgate.com>
Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
|
||
|---|---|---|
| .github | ||
| atuin-client | ||
| atuin-common | ||
| atuin-server | ||
| docs | ||
| src | ||
| .dockerignore | ||
| .gitignore | ||
| atuin.plugin.zsh | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| demo.gif | ||
| Dockerfile | ||
| install.sh | ||
| LICENSE | ||
| README.md | ||
Atuin
magical shell history
exit code, duration, time and command shown
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.
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
upandctrl-rwith 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>
Documentation
- Quickstart
- Install
- Import
- Configuration
- Searching history
- Cloud history sync
- History stats
- Running your own server
- Key binding
Supported Shells
- zsh
- bash
Quickstart
bash <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)
atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
atuin import auto
atuin sync
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 (AUR, homebrew, etc etc).
# do not run this as root, root will be asked for if required
bash <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)
With cargo
It's best to use rustup to get setup with a Rust toolchain, then you can run:
cargo install atuin
Homebrew
brew tap ellie/atuin
brew install atuin
AUR
Atuin is available on the AUR
yay -S atuin # or your AUR helper of choice
From source
git clone https://github.com/ellie/atuin.git
cd atuin
cargo install --path .
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!
zsh
echo 'eval "$(atuin init zsh)"' >> ~/.zshrc
Or using a plugin manager:
zinit load ellie/atuin
bash
We need to setup some hooks, so first install bash-preexec:
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
...what's with the name?
Atuin is named after "The Great A'Tuin", a giant turtle from Terry Pratchett's Discworld series of books.