diff --git a/apps/atuin/config.json b/apps/atuin/config.json index e5456d3f..c9acba7f 100755 --- a/apps/atuin/config.json +++ b/apps/atuin/config.json @@ -1,11 +1,11 @@ { "$schema": "../schema.json", - "name": "Atuin", + "name": "Atuin Server", "available": true, "exposable": true, "port": 8888, "id": "atuin", - "tipi_version": 2, + "tipi_version": 1, "version": "latest", "categories": [ "utilities", @@ -15,6 +15,7 @@ "short_desc": "Magical Shell History", "author": "atuinsh", "source": "https://github.com/atuinsh/atuin", + "website": "https://atuin.sh", "form_fields": [ { "type": "password", @@ -23,5 +24,5 @@ "env_variable": "ATUIN_DB_PASSWORD" } ], - "supported_architectures": ["amd64"] + "supported_architectures": ["amd64","arm64"] } diff --git a/apps/atuin/metadata/description.md b/apps/atuin/metadata/description.md index 95796ff0..197c3cf5 100755 --- a/apps/atuin/metadata/description.md +++ b/apps/atuin/metadata/description.md @@ -1,5 +1,31 @@ -# Atuin +# Atuin Server ## Making your shell magical -Sync, search and backup shell history with Atuin \ No newline at end of file +Sync, search and backup shell history with Atuin + +[Atuin](https://atuin.sh) is an open-source Terminal User Interface (TUI) for your shell history. + +![Atuin TUI screenshot](https://atuin.sh/_astro/cargo-prefix.322ce063_Z3NFdB.avif) + +## Features + +1. Shell History Sync + - Sync your shell history to all of your machines, wherever they are +1. End-to-end Encryption + - All data is encrypted, and can only be read by you +1. Efficient Search + - Search decades of shell history, and recall it in an instant. Atuin offers configurable full text or fuzzy search, filterable by host, directory, etc. +1. Data Import + - Bring your existing history with you - Atuin supports importing from a wide variety of formats +1. Store Extra Context + - Atuin stores extra context with your commands - working directory, exit code, and more! + +## Self-hosted sync server + +Atuin.sh offers a free, fully-encrypted option for storing your synced shell history as well as an option to self-host a sync server of your own. This is an easy-to-use package for the Atuin sync server component; the user interface is the TUI, which can be installed using many typical package-management tools, e.g. + +- `brew install atuin` +- `apt install atuin` + +or via `bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)`. \ No newline at end of file