Marko Vejnovic
06fffd94f3
Most people reading these docs are not reading them in their first language. This applies the mechanically checkable parts of ASD-STE100 Simplified Technical English (issue 9) to docs/docs and to the strings the program prints. The linter came first, because it was pulling the other way. Microsoft.Contractions is an error-level rule whose autofix rewrites "cannot" to "can't", so CI was actively pushing the docs toward the one construction a second-language reader has the most trouble with: the elided word carries the negation, and the apostrophe form is not derivable from the words it stands for. That rule is now off, and .vale/styles/STE holds the inverse. The new style implements only what a linter can check, each rule file naming the STE rule behind it: Contractions, AmbiguousContractions rule 4.2 LatinAbbrev GR-6 PhrasalVerbs rule 9.3 SentenceLength rule 6.3 (25 words) Spelling rule 1.14 Applied across docs/docs: 202 contractions expanded, 32 Latin abbreviations and bare "via" replaced by the English word that fits each sentence, and 62 over-long sentences split or turned into vertical lists (rule 4.3). Vale is now clean at the level CI gates on. Three STE rules are deliberately not adopted, and CONTRIBUTING explains why: the approved-word list is a 900-word aerospace vocabulary with no entry for "daemon" or "sync", the ban on -ing forms would rename every "Getting started" heading, and a strict reading of the active voice would force us to invent agents for descriptions that have none. Also fixes a bug in TokenIgnores that predates this work. The pattern matched bare "/word", including inside fenced code blocks, where a match desynchronizes Vale's block parser and silently drops every alert in the rest of the file. Ten of 51 pages were unlinted from as early as line 32. Requiring the leading [~.] fixes it and surfaced two error-level alerts that were already red on main. For the Rust strings: semicolons removed from messages (rule 8.1), contractions expanded, and the format-error help rewritten as short imperatives. Behavioural strings only, no logic changes.
magical shell history
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.
exit code, duration, time and command shown
As well as the search UI, it can do things like this:
# search for all successful `make` commands, recorded after 3pm yesterday
atuin search --exit 0 --after "yesterday 3pm" make
You may use either the server I host, or host your own! Or just don't use sync at all. As all history sync is encrypted, I couldn't access your data even if I wanted to. And I really don't want to.
Features
- rebind
ctrl-randup(configurable) to a full screen history search UI - store shell history in a sqlite database
- back up and sync encrypted shell history
- the same history across terminals, across sessions, and across machines
- log exit code, cwd, hostname, session, command duration, etc
- calculate statistics such as "most used command"
- old history file is not replaced
- quick-jump to previous items with Alt-<num>
- switch filter modes via ctrl-r; search history just from the current session, directory, or globally
- enter to execute a command, tab to edit
Documentation
Supported platforms
Atuin supports zsh, bash, fish, nushell, xonsh, and PowerShell. See Supported platforms for the full matrix and what each tier means.
Community
Forum
Atuin has a community forum, please ask here for help and support: https://forum.atuin.sh/
IRC
We're also available via #atuin on libera.chat
Discord
Atuin also has a community Discord, available here
Quickstart
This will sign you up for the Atuin Cloud sync server. Everything is end-to-end encrypted, so your secrets are safe!
Read the docs for an offline setup, self-hosted server, and more.
curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh
atuin register -u <USERNAME> -e <EMAIL>
atuin import auto
atuin sync
Then restart your shell!
Note
For Bash users: The above sets up
bash-preexecfor necessary hooks, butbash-preexechas limitations. For details, please see the Bash section of the shell plugin documentation.
Security
If you find any security issues, we'd appreciate it if you could alert ellie@atuin.sh
Related projects
Please open a PR for any others!
Contributors
Made with contrib.rocks.