diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 45 |
1 files changed, 24 insertions, 21 deletions
@@ -29,7 +29,7 @@ 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. +server. @@ -90,7 +90,7 @@ I wanted to. And I **really** don't want to. - fish - nushell - xonsh - + ## Community ### Forum @@ -102,11 +102,11 @@ Atuin has a community forum, please ask here for help and support: https://forum Atuin also has a community Discord, available [here](https://discord.gg/jR3tfchVvW) # Quickstart - + ## With the default sync server - + This will sign you up for the default sync server, hosted by me. Everything is end-to-end encrypted, so your secrets are safe! - + Read more below for offline-only usage, or for hosting your own server. ``` @@ -130,10 +130,10 @@ Then restart your shell! > section below. ## Offline only (no sync) - + ``` bash <(curl https://raw.githubusercontent.com/atuinsh/atuin/main/install.sh) - + atuin import auto ``` @@ -171,25 +171,28 @@ toolchain, then you can run: ``` cargo install atuin ``` - + And then follow [the shell setup](#shell-plugin) +#### Daemon Build Dependencies +[Protoc](https://grpc.io/docs/protoc-installation/) is required to build the daemon, which is enabled by default. This is because we use protobufs for the message serialization + ### 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/) - +Atuin is also available in [MacPorts](https://ports.macports.org/port/atuin/) + ``` sudo port install atuin ``` - + And then follow [the shell setup](#shell-plugin) ### Cave @@ -223,7 +226,7 @@ Atuin is available in the Arch Linux [[extra] repository](https://archlinux.org/ ``` pacman -S atuin ``` - + And then follow [the shell setup](#shell-plugin) ### Xbps @@ -243,7 +246,7 @@ Atuin is available in the Termux package repository: ``` pkg install atuin ``` - + And then follow [the shell setup](#shell-plugin) ### From source @@ -253,7 +256,7 @@ git clone https://github.com/atuinsh/atuin.git cd atuin/crates/atuin cargo install --path . ``` - + And then follow [the shell setup](#shell-plugin) ## Shell plugin @@ -273,9 +276,9 @@ echo 'eval "$(atuin init zsh)"' >> ~/.zshrc zinit load atuinsh/atuin ``` -#### Antigen - -```sh +#### Antigen + +```sh antigen bundle atuinsh/atuin@main ``` @@ -345,7 +348,7 @@ atuin init fish | source ``` to your `is-interactive` block in your `~/.config/fish/config.fish` file - + ### Nushell Run in *Nushell*: @@ -371,7 +374,7 @@ to the end of your `~/.xonshrc` # Security -If you find any security issues, we'd appreciate it if you could alert ellie@atuin.sh +If you find any security issues, we'd appreciate it if you could alert ellie@atuin.sh # Contributors |