blob: 1533e3c8e77274a7c45fe768722ba916f6bf6974 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
<h1 align="center">
Atuin
</h1>
<em align="center">Magical shell history</em>
<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>
- store shell history in a sqlite database
- back up e2e encrypted history to the cloud, and synchronize between machines
- log exit code, cwd, hostname, session, command duration, etc
- smart interactive history search to replace ctrl-r
- calculate statistics such as "most used command"
- old history file is not replaced
## Documentation
- [Quickstart](#quickstart)
- [Install](#install)
- [Import](docs/import.md)
- [Configuration](docs/config.md)
- [Searching history](docs/search.md)
- [Cloud history sync](docs/sync.md)
- [History stats](docs/stats.md)
## Supported Shells
- zsh
# Quickstart
```
curl https://github.com/ellie/atuin/blob/main/install.sh | bash
atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
atuin import auto
atuin sync
```
## Install
### AUR
Atuin is available on the [AUR](https://aur.archlinux.org/packages/atuin/)
```
yay -S atuin # or your AUR helper of choice
```
### 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
```
### 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. Add
```
eval "$(atuin init)"
```
to your `.zshrc`
## ...what's with the name?
Atuin is named after "The Great A'Tuin", a giant turtle from Terry Pratchett's
Discworld series of books.
|
