atuin/README.md

80 lines
2.0 KiB
Markdown
Raw Normal View History

2021-02-13 13:55:53 +01:00
<h1 align="center">
A'tuin
</h1>
<blockquote align="center">
Through the fathomless deeps of space swims the star turtle Great ATuin, bearing on its back the four giant elephants who carry on their shoulders the mass of the Discworld.
</blockquote>
2021-02-14 17:23:08 +01:00
<p align="center">
<a href="https://github.com/ellie/atuin/actions?query=workflow%3ARust"><img src="https://img.shields.io/github/workflow/status/ellie/atuin/Rust?style=flat-square" /></a>
<a href="https://crates.io/crates/atuin"><img src="https://img.shields.io/crates/v/atuin.svg?style=flat-square" /></a>
<a href="https://crates.io/crates/atuin"><img src="https://img.shields.io/crates/d/atuin.svg?style=flat-square" /></a>
<a href="https://github.com/ellie/atuin/blob/main/LICENSE"><img src="https://img.shields.io/crates/l/atuin.svg?style=flat-square" /></a>
</p>
2021-02-13 13:55:53 +01:00
2021-02-13 22:21:00 +01:00
A'tuin manages and synchronizes your shell history! Instead of storing
everything in a text file (such as ~/.history), A'tuin uses a sqlite database.
While being a little more complex, this allows for more functionality.
2021-02-13 21:21:49 +01:00
2021-02-13 22:21:00 +01:00
As well as the expected command, A'tuin stores
2021-02-13 21:21:49 +01:00
- duration
- exit code
- working directory
- hostname
- time
- a unique session ID
2021-02-13 21:54:35 +01:00
## Install
2021-02-14 19:20:18 +01:00
`atuin` needs a nightly version of Rust + Cargo! It's best to use
2021-02-13 22:21:00 +01:00
[rustup](https://rustup.rs/) for getting set up there.
2021-02-13 21:54:35 +01:00
2021-02-14 19:20:18 +01:00
```
rustup default nightly
```
2021-02-13 21:54:35 +01:00
```
cargo install atuin
```
2021-02-13 22:21:00 +01:00
Once the binary is installed, the shell plugin requires installing:
2021-02-13 21:54:35 +01:00
2021-02-13 22:21:00 +01:00
zplug:
2021-02-13 21:54:35 +01:00
2021-02-13 22:21:00 +01:00
```
2021-02-14 00:06:59 +01:00
zplug "ellie/atuin", at:main
2021-02-13 22:21:00 +01:00
```
2021-02-13 21:54:35 +01:00
2021-02-14 00:22:58 +01:00
otherwise, clone the repo and `source /path/to/repo/atuin.plugin.zsh` in your `.zshrc`
2021-02-13 21:54:35 +01:00
## Usage
By default A'tuin will rebind ctrl-r to use fzf to fuzzy search your history. You
can specify a different fuzzy tool by changing the value of `ATUIN_FUZZY`:
```
export ATUIN_FUZZY=fzy
```
2021-02-13 21:54:35 +01:00
### Import history
```
atuin import auto # detect shell, then import
or
2021-02-13 21:54:35 +01:00
atuin import zsh # specify shell
```
### List history
```
atuin history list
```
2021-02-13 22:21:00 +01:00
## ...what's with the name?
A'tuin is named after "The Great A'tuin", a giant turtle from Terry Pratchett's
Discworld series of books.