ellie/atuin
1
1
Fork 0
mirror of https://github.com/ellie/atuin.git synced 2024-09-11 21:18:22 +03:00
Code Issues Projects Releases Wiki Activity
🐢 Magical shell history
82 Commits 57 Branches 34 Tags 64 MiB
Rust 94.9%
Shell 3.2%
Nix 0.5%
PLpgSQL 0.5%
Xonsh 0.4%
Other 0.5%
156893d774
Go to file
Ellie Huxtable 156893d774
Update docs, unify on SQLx, bugfixes (#40) 
* Begin moving to sqlx for local too

* Stupid scanners should just have a nice cup of tea

Random internet shit searching for /.env or whatever

* Remove diesel and rusqlite fully
2021-04-25 17:21:52 +00:00
.github Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
atuin-client Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
atuin-common Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
atuin-server Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
docs Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
src Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
.dockerignore Optimise docker (#34) 2021-04-14 17:40:50 +00:00
.gitignore Use cargo workspaces (#37) 2021-04-20 20:53:07 +00:00
Cargo.lock Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
Cargo.toml Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
diesel.toml Implement server (#23) 2021-03-21 20:04:39 +00:00
Dockerfile Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
install.sh Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00
LICENSE Create LICENSE 2021-02-14 16:22:25 +00:00
README.md Update docs, unify on SQLx, bugfixes (#40) 2021-04-25 17:21:52 +00:00

README.md

Atuin

Magical shell history

  • 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

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

yay -S atuin # or your AUR helper of choice

With cargo

It's best to use rustup 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.