jonah/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2026-02-07 00:45:49 +01:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

docs(README): update links (#3116)
Some checks failed
Codespell / Check for spelling errors (push) Has been cancelled
Details
build-docker / publish_x86 (push) Has been cancelled
Details
build-docker / publish_aarch64 (push) Has been cancelled
Details
build-docker / publish_manifest (push) Has been cancelled
Details
Install / install (ubuntu-latest) (push) Has been cancelled
Details
Install / install (macos-14) (push) Has been cancelled
Details
Nix / check (push) Has been cancelled
Details
Nix / build-test (push) Has been cancelled
Details
Rust / build (macos-14) (push) Has been cancelled
Details
Rust / build (ubuntu-latest) (push) Has been cancelled
Details
Rust / build (windows-latest) (push) Has been cancelled
Details
Rust / cross-compile (x86_64-unknown-illumos) (push) Has been cancelled
Details
Rust / unit-test (macos-14) (push) Has been cancelled
Details
Rust / unit-test (ubuntu-latest) (push) Has been cancelled
Details
Rust / unit-test (windows-latest) (push) Has been cancelled
Details
Rust / check (macos-14) (push) Has been cancelled
Details
Rust / check (ubuntu-latest) (push) Has been cancelled
Details
Rust / check (windows-latest) (push) Has been cancelled
Details
Rust / integration-test (push) Has been cancelled
Details
Rust / clippy (push) Has been cancelled
Details
Rust / format (push) Has been cancelled
Details
Shellcheck / shellcheck (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Zhizhen He
2026-01-30 11:41:20 +08:00
committed by GitHub
parent 78cc70b0b7
commit 97c3b77d27
1 changed files with 5 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -21,18 +21,13 @@
<a href="https://twitter.com/atuinsh"><img src="https://img.shields.io/twitter/follow/atuinsh?style=social" /></a>
</p>
[English] | [简体中文]
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.
<p align="center">
<img src="demo.gif" alt="animated" width="80%" />
</p>
@@ -41,10 +36,6 @@ server.
<em>exit code, duration, time and command shown</em>
</p>
As well as the search UI, it can do things like this:
```
@@ -76,6 +67,7 @@ I wanted to. And I **really** don't want to.
- [Setting up sync](https://docs.atuin.sh/guide/sync/)
- [Import history](https://docs.atuin.sh/guide/import/)
- [Basic usage](https://docs.atuin.sh/guide/basic-usage/)
## Supported Shells
- zsh
@@ -89,7 +81,7 @@ I wanted to. And I **really** don't want to.
### Forum
Atuin has a community forum, please ask here for help and support: https://forum.atuin.sh/
Atuin has a community forum, please ask here for help and support: <https://forum.atuin.sh/>
### Discord
@@ -114,13 +106,13 @@ Then restart your shell!
> [!NOTE]
>
> **For Bash users**: The above sets up `bash-preexec` for necessary hooks, but
> `bash-preexec` has limitations. For details, please see the
> `bash-preexec` has limitations. For details, please see the
> [Bash](https://docs.atuin.sh/guide/installation/#installing-the-shell-plugin)
> section of the shell plugin documentation.
# 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
@@ -131,4 +123,4 @@ If you find any security issues, we'd appreciate it if you could alert ellie@atu
Made with [contrib.rocks](https://contrib.rocks).
[English]: ./README.md
[简体中文]: ./docs/zh-CN/README.md
[简体中文]: ./docs-i18n/zh-CN/README.md