aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYummyOreo <bobgim20@gmail.com>2024-05-12 21:35:34 -0500
committerGitHub <noreply@github.com>2024-05-13 09:35:34 +0700
commitce67e527722cadd4ed7341a3e5d433beb62887f6 (patch)
tree41ff5ccc9d6857d1d4173a0a61f99174b644cb9e /README.md
parentfix: add incremental rebuild to daemon loop (#2010) (diff)
downloadatuin-ce67e527722cadd4ed7341a3e5d433beb62887f6.zip
feat(daemon): add support for daemon on windows (#2014)
* fix: gracefully exit on windows * feat(daemon): tcp support for windows * feat(daemon): add tcp port configuration * fix: logging and fix compiler error * docs: add build dependency to the readme fix(docs): move a line up * fix: missing field error * docs: adds the daemon section to the default config * fix: clippy and fmt * feat: Update README.md Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com> * refactor: changes tcp port and other stuff as per request * fix(config): update default tcp port in example config * fix: complier error on unix * refactor: make the cfg stuff look better --------- Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
Diffstat (limited to '')
-rw-r--r--README.md45
1 files changed, 24 insertions, 21 deletions
diff --git a/README.md b/README.md
index 64f126b8..1bff59ec 100644
--- a/README.md
+++ b/README.md
@@ -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