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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
---
title: Advanced Install
---
Generally, we recommend using our install script. It ensures you use the most
up-to-date Atuin, and that your shell plugin is correctly setup. It will prefer
the system package manager wherever necessary!
However, I totally understand if you'd rather do things yourself and not run a
script from the internet. If so, follow on!
## Install Atuin
Atuin is in a number of package repositories! Please choose whichever works best for you.
### 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 '<nixpkgs>' -iA atuin
```
And then follow [the shell setup](#shell-plugin)
### Pacman
Atuin is available in the Arch Linux [community repository](https://archlinux.org/packages/community/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
Note: Atuin builds on the latest stable version of Rust, and we make no
promises regarding older versions. We recommend using rustup.
```
git clone https://github.com/atuinsh/atuin.git
cd atuin/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! 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
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
```
**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
### Fig
Install `atuin` shell plugin in zsh, bash, or fish with [Fig](https://fig.io) in one click.
<a href="https://fig.io/plugins/other/atuin" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a>
### 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
```
|
