aboutsummaryrefslogtreecommitdiffstats
path: root/docs (follow)
Commit message (Collapse)AuthorAge
* feat: Add history author/intent metadata and v1 record version (#3205)Ellie Huxtable2026-02-25
| | | | | | | | | | | | | | | | | | | | | | | | <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Adds `author` and `intent` to client history records and DB persistence, including migration/backfill and CLI/daemon propagation. Introduces V2 record-store history version `v1` while retaining read compatibility for legacy `v0` records. Adds `--author` and `--intent` flags to `atuin history start`, plus `{author}` and `{intent}` format keys for listing/history output. Updates shell-integration docs for `ATUIN_HISTORY_AUTHOR` and `ATUIN_HISTORY_INTENT`, and updates related tests/fixtures. Validated with `cargo test -p atuin-client --lib`, `cargo test -p atuin-daemon --tests`, `cargo test -p atuin search::inspector`, and `cargo fmt --check`.
* feat: Generate commands or ask questions with `atuin ai` (#3199)Michelle Tilley2026-02-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This PR refines the system created in #3178 to be suitable for a v1 release. --- ## Overview `atuin-ai` is a separate binary that allows for generating commands and asking questions from the command line. It is fully opt-in. ## Usage `atuin ai init` will output bindings for your shell. Currently, bash, zsh, and fish are supported. ```bash eval "$(atuin ai init)" ``` Once the hooks are installed, just press `?` on an empty prompt line to call up the TUI. `atuin ai` requires an account on [Atuin Hub](https://hub.atuin.sh/); you will be prompted to log in on first use. ## Features ### Command generation Prompt the LLM to create a command, and get one back, no fuss. Press `enter` to run, or `tab` to insert. ``` ┌Ask questions or generate a command:──────────────────────────┐ │ │ │ > Get a list of running docker containers │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ docker ps │ │ │ └────[Enter]: Run [Tab]: Insert [f]: Follow-up [Esc]: Cancel┘ ``` ### Follow-up You can follow-up with `f` to specify a refinement prompt to update the command that will be inserted. ``` ┌Ask questions or generate a command:──────────────────────────┐ │ │ │ > Get a list of running docker containers │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ docker ps │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ > Actually I want to get all docker containers │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ docker ps -a │ │ │ └────[Enter]: Run [Tab]: Insert [f]: Follow-up [Esc]: Cancel┘ ``` You can also follow-up with questions to get responses in natural language. ``` ┌Ask questions or generate a command:──────────────────────────┐ │ │ │ > Get a list of running docker containers │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ docker ps │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ > Actually I want to get all docker containers │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ docker ps -a │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ > What other useful flags to `docker ps` should I know? │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ Here are some handy `docker ps` flags: │ │ │ │ - `-q` — Only show container IDs (great for piping to │ │ other commands) │ │ - `-s` — Show container sizes │ │ - `-n 5` — Show the last 5 created containers │ │ - `-l` — Show only the latest created container │ │ - `--no-trunc` — Don't truncate output (shows full IDs and │ │ commands) │ │ - `-f` or `--filter` — Filter by condition, e.g.: │ │ - `-f status=exited` — only exited containers │ │ - `-f name=myapp` — filter by name │ │ - `-f ancestor=nginx` — filter by image │ │ - `--format` — Custom output using Go templates, e.g.: │ │ `--format "table {{.Names}}\t{{.Status}}\t{{.Ports}}"` │ │ │ │ A common combo is `docker ps -aq` to get all container │ │ IDs, useful for bulk operations like `docker rm $(docker │ │ ps -aq)`. │ │ │ └────[Enter]: Run [Tab]: Insert [f]: Follow-up [Esc]: Cancel┘ ``` You can use `enter` or `tab` at any time to run or insert the last suggested command, even if it was suggested in a previous turn. ### Conversational and search usage If you prompt the LLM with a question that doesn't imply you want to generate a command, it can respond in natural language, and use web search if necessary to fetch the data it needs. ``` ┌Ask questions or generate a command:──────────────────────────┐ │ │ │ > What is the latest version of atuin? │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ ✓ Used 2 tools │ │ │ │ The latest version of Atuin is **v18.12.0**, available on │ │ the [GitHub releases │ │ page](https://github.com/atuinsh/atuin/releases). │ │ │ └─────────────────────────────────[f]: Follow-up [Esc]: Cancel┘ ``` ### Dangerous or low-confidence command detection The LLM scores its confidence in the command, as well as how dangerous the command is. This information is shown if a threshold is exceeded, and requires an extra confirmation step before running automatically with `enter`. The Atuin Hub server also monitors suggested commands for dangerous patterns the LLM didn't catch, and appends its own assessment at the end of the LLM's own assessment. ``` ┌Ask questions or generate a command:──────────────────────────┐ │ │ │ > Delete all files from $HOME │ │ │ ├──────────────────────────────────────────────────────────────┤ │ │ │ $ rm -rf $HOME/* │ │ │ │ ! ⚠️ This will PERMANENTLY delete ALL files and directories │ │ in your home directory, including documents, downloads, │ │ configurations, SSH keys, and everything else. This is │ │ irreversible and will likely break your system. Also note │ │ this won't delete hidden (dot) files — if you want those │ │ too, that's even more destructive.; [Server] Recursive │ │ delete of critical directory │ │ │ └────[Enter]: Run [Tab]: Insert [f]: Follow-up [Esc]: Cancel┘ ``` --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs: Document `search.filters` (#3195)David Crespo2026-02-18
|
* docs: Update config.md to remove NuShell support note (#3190)Onè2026-02-17
| | | | | | | | | | | | | | | | | | Removed unsupported note about NuShell from configuration documentation. Possibly better alternative would be to say from which version of nushell and atuin support started. Didn't want to spend the time researching that in case it wasn't of value. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x ] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x ] I have checked that there are no existing pull requests for the same thing
* feat: add autostart and pid management to daemon (#3180)Ellie Huxtable2026-02-13
|
* fix(docs): Update Postgres volume path in Docker as required by pg18 (#3174)Silviu Vulcan2026-02-12
| | | | | | | | | | | | | | | Postgresql requires a different volume path for docker since version 18, see https://hub.docker.com/_/postgres#pgdata <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* feat(docs): Add Shell Integration and Interoperability docs (#3163)Michelle Tilley2026-02-11
| | | | | | | | | | | | | | | | | | | | This PR adds a new documentation page called "Shell Integration and Interoperability." It explains how Atuin's shell hooks work, and why they may _not_ work by default in an embedded terminal in another tool. It includes suggestions to ensure the shell is launched in interactive mode, or to use a wrapper script if this isn't possible. It also explains the various mechanisms to use to _exclude_ certain commands, or commands from certain tools, from Atuin's history. Closes #3085 Closes #1545 Closes #2983 Related to: #1942, #3047, #1847 --------- Co-authored-by: Koichi Murase <myoga.murase@gmail.com> Co-authored-by: Ellie Huxtable <ellie@atuin.sh>
* feat: `switch-context` (#3149)Lucas Trzesniewski2026-02-11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This PR lets you change the current search context to the one of the currently selected command, which lets you easily see the surrounding commands of its session. It adds the following: - `switch-context` and `clear-context` actions - A `has-context` condition - `CTX:` and `C>` prefixes to show we're in another context The `switch-context` behavior is as follows: - The selected command defines the new context - The filter mode is automatically switched to SESSION - The search input is cleared, which gives you a full overview of the other commands executed in the same session - The command which triggered this mode keeps being selected to get a clear overview - The filter mode can be changed to modes such as DIRECTORY, but not to GLOBAL or SESSION+ as IMO those would be confusing in this mode This lets you easily navigate between modes and commands the way you prefer, for instance by switching the context through selected commands or switching back to the default mode with the same key. This could certainly still be improved (the docs are missing for instance), and if you have any feedback I can change the behavior as you see fit. I can add the docs when you'll approve the new names. Closes #2784 ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing --------- Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
* feat: Add original-input-empty keybind condition (#3171)Michelle Tilley2026-02-11
| | | | | | | | | | | | | | | | This PR adds a keybind condition called `original-input-empty` that is true when the TUI was invoked from an empty prompt line; users can use this to change behavior based on the original prompt's contents; for example: ```toml [keymap.emacs] "esc" = [ { when = "original-input-empty", action = "return-query" }, { action = "return-original" } ] ``` Thanks Hazilo in Discord for the suggestion.
* feat: expand keybinding system with vim motions, media keys, and inspector ↵Michelle Tilley2026-02-11
| | | | | | | | | | | | | | | | | improvements (#3161) Addresses the keybinding audit (#3157): - Add missing vim-normal bindings: 0, $, w, b, e, x, dd, D, C - Add new CursorWordEnd action for vim 'e' motion - Add VimChangeToEnd action for vim 'C' motion - Add Media key support (play, pause, stop, volume, etc.) - Refactor inspector keymap to be minimal but respect enter_accept and provide vim-style j/k navigation for vim users - Add $ to special character parsing - Replace eprintln! with tracing::warn! for config errors - Document shifted punctuation keys and media keys To be rebased once #3158 is merged
* docs: update how to use Docker to self-host (#3148)Marius Nuennerich2026-02-08
| | | | | | | | | | | | | | | | The server command changed with the switch to a separate server binary. While here also update the documented postgres version. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* feat(tui): add clear-to-start/end actions (#3141)依云2026-02-06
| | | | | | | | | | | | | | e.g. bash has these mapped to Ctrl-u/k. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* fix(tui): space and F1-F24 keys not handled properly by new keybind system ↵Michelle Tilley2026-02-05
| | | | | | | | | | (#3138) Fixes two keymap issues introduced in #3127: 1. Space key does nothing - Pressing space in the search input didn't insert a space character 2. F12 not recognized - Function keys (F1-F24) couldn't be used in `[keymap]` config
* Add advanced key binding to docs listMichelle Tilley2026-02-05
|
* feat: Add new custom keybinding system for search TUI (#3127)Michelle Tilley2026-02-05
|
* docs: add history deletion guide (#3130)Ellie Huxtable2026-02-03
| | | | | | | | | | | | <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [ ] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [ ] I have checked that there are no existing pull requests for the same thing
* docs: update the `[keys]` docs (#3114)Lucas Trzesniewski2026-02-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is related to: - #3090 - #1906 --- ## No longer relevant: ~I often just hold the backspace key to clear the query line in Atuin, and the change in #3090 makes it no longer possible: it accepts the current history entry instead.~ 🤯 ~It may be a muscle memory thing, but it also feels wrong to me for the left key to accept the current entry. I'd prefer for it to do nothing when the cursor is at the start of the line (I've set `exit_past_line_start = false` in my config).~ ~This PR makes the new behavior configurable: it adds an `accept_past_empty_line` setting (naming is *hard*, feel free to find a better name) which lets you disable it. It also updates the `[keys]` docs.~ BTW wouldn't setting the `accept_past_line_start` and `accept_with_backspace` settings to `true` (maybe by default) have the same effect as what #3090 introduced? ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* feat: remove user verification functionality (#3108)Ellie Huxtable2026-01-27
| | | | | | | | | | | | | | | | <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [ ] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [ ] I have checked that there are no existing pull requests for the same thing --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
* docs: add PowerShell install instructionsLucas Trzesniewski2026-01-24
| | | | Co-authored-by: Mateusz Łoskot <mateusz@loskot.net>
* feat: add more vim movement bindings for navigation (#3041)Yan Ivnitskiy2026-01-23
| | | | | | | | | | | | | | | | | | | | | | | | | Add vim-style movement commands to vim_normal keymap mode: - Ctrl+u/d: half-page up/down - Ctrl+b/f: full-page up/down - G: jump to visual bottom of history - gg: jump to visual top of history (multi-key sequence) - H/M/L: jump to top/middle/bottom of visible screen Also adds `offset()` getter to ListState for H/M/L functionality, and includes tests for the new bindings. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* chore(deps)!: update tls deps, remove built-in tls server support (#3091)Ellie Huxtable2026-01-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | Update reqwest from 0.12 to 0.13 and remove the built-in TLS termination from atuin-server. Users should use a reverse proxy (nginx, caddy, traefik) for TLS/HTTPS support instead. This removes: - axum-server and rustls dependencies - The [tls] configuration section - The launch_with_tls function Also updates metrics-exporter-prometheus from 0.17 to 0.18. The reverse proxy approach is standard and provides better flexibility for certificate management. I'd rather keep our server stack as minimal as possible. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [ ] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [ ] I have checked that there are no existing pull requests for the same thing
* feat: add custom column support (#3089)Ellie Huxtable2026-01-22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Configure the interactive search UI appearance. Resolves #998 ```toml [ui] columns = ["duration", "time", "command"] ``` ### `columns` Default: `["duration", "time", "command"]` Columns to display in the interactive search, from left to right. The selection indicator (`" > "`) is always shown first implicitly. Each column can be specified as: - A simple string (uses default width): `"duration"` - An object with type and optional width/expand: `{ type = "directory", width = 30 }` #### Available column types | Column | Default Width | Description | | --------- | ------------- | ----------------------------------------------- | | duration | 5 | Command execution duration (e.g., "123ms") | | time | 8 | Relative time since execution (e.g., "59m ago") | | datetime | 16 | Absolute timestamp (e.g., "2025-01-22 14:35") | | directory | 20 | Working directory (truncated if too long) | | host | 15 | Hostname | | user | 10 | Username | | exit | 3 | Exit code (colored by success/failure) | | command | * | The command itself (expands by default) | #### Column options - **type**: The column type (required when using object format) - **width**: Custom width in characters (optional, uses default if not specified) - **expand**: If `true`, the column fills remaining space. Default is `true` for `command`, `false` for others. Only one column should have `expand = true`. #### Examples ```toml # Minimal - more space for commands columns = ["duration", "command"] # With custom directory width columns = ["duration", { type = "directory", width = 30 }, "command"] # Show host for multi-machine sync users columns = ["duration", "time", "host", "command"] # Show exit codes prominently columns = ["exit", "duration", "command"] # Make directory expand instead of command columns = ["duration", "time", { type = "directory", expand = true }, { type = "command", expand = false }] ```
* docker.mdx: config/ with initial uid:gidPierre Carru2026-01-16
| | | | Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* docs: small edit to themes website file (#3069)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/103 **Original author:** @AtomicRobotMan0101 --- meaninglessly small edit. I'm also working on a simple python script to add themes from the GOGH project into the /themes folder with appropriate mappings. I'll jump on the discord to discuss the plan :-) --------- Co-authored-by: Evan McBeth <64177332+AtomicRobotMan0101@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Ellie Huxtable <ellie@atuin.sh> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
* docs(configuration): describe new utility "atuin-bind" for Bash (#3064)Koichi Murase2026-01-16
| | | | | | | | | | | | | | | | Moved from https://github.com/atuinsh/docs/pull/106. Since the PRs in [`atuin/docs`](https://github.com/atuinsh/docs) seem to have been invalidated by https://github.com/atuinsh/docs/pull/112 and #3018, let me re-create the PR here. This is the documentation update associated with the change introduced in [atuinsh/atuin#2953](https://github.com/atuinsh/atuin/pull/2953). The current documentation about Bash's bindings is outdated. ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* docs: Expand and clarify usage of the history prune command (#3084)Waldir Pimenta2026-01-16
| | | | | | | | | | | | | | | Added a bit of context to make it clearer how this command works and when one might want to use it. <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* Fix keybind I broke during docs PR migrationMichelle Tilley2026-01-16
|
* docs: Fix punctuation and grammar in basic usage guide (#3063)Waldir Pimenta2026-01-16
| | | | | | | | | | | | | | | | | | | | | Just a few punctuation, spelling and grammar fixes, along with a couple of wording changes for clarity. _Note: This PR is a recreation of https://github.com/atuinsh/docs/pull/110, following the migration of the docs to this repo (https://github.com/atuinsh/docs/pull/112 + #3018)._ <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Co-authored-by: Michelle Tilley <michelle@michelletilley.net>
* faq: add alternative projects (#3076)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/77 **Original author:** @Finkregh --- I always love it when similar projects link to each other :) Co-authored-by: Oluf Lorenzen <finkregh@mafia-server.net> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Add ~/.config/atuin deletion to uninstall docs (#3070)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/100 **Original author:** @justinmayer --- Since the `~/.config/atuin` directory (and configuration files within) appear to be created when Atuin is first invoked, this directory should be added to the list of directories to be deleted in the uninstall documentation. Co-authored-by: Justin Mayer <entroP@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Small formatting fix (#3072)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/91 **Original author:** @sokai --- for better readability/consistency Co-authored-by: sokai <sokai@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Add FAQ entry on how to import unsynced atuin history (#3075)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/78 **Original author:** @kzdnk --- I found myself stuck in this situation, and thought it might be useful to someone else. Please let me now if this should rather be on the on the discourse forum and I will post it there. If atuin is not disabled, `~/.local/share/atuin` will be emptied after the copying is finished. Co-authored-by: Krzysztof Zduniak <74667483+ziutech@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Update key-binding.mdx (#3077)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/76 **Original author:** @AtomicRobotMan0101 --- trivial amendment to show the use of an alternative binding for BASH Co-authored-by: Evan McBeth <64177332+AtomicRobotMan0101@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs: Disambiguate 'setup' (noun) vs. 'set up' (verb) (#3061)Waldir Pimenta2026-01-16
| | | | | | | | | | | | <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing
* docs: Various improvements to the `atuin import` docs (#3062)Waldir Pimenta2026-01-16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Recreation of PR https://github.com/atuinsh/docs/pull/111, after the migration of the docs to this repo (#3018). Copying the description from that PR, for convenience: This PR implements a few improvements to the import doc page. 1. **Fix name of `zsh-hist-db` and `xonsh-sqlite` subcommands** The `atuin import` subcommands `zsh-hist-db` and `xonsh-sqlite` were incorrectly documented as `zsh_histdb` and `xonsh_sqlite`, respectively. This is likely due to the actual modules that implement the import functionality being indeed named `zsh_histdb` and `xonsh_sqlite` (see [here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin/src/command/client/import.rs#L14) and [here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin-client/src/import/mod.rs#L19-L21)), but for the end-user, that results in documentation that's confusing at best, and error-inducing at worst. Fixes issue [atuinsh/atuin#2533](https://github.com/atuinsh/atuin/issues/2533). 2. **Document the `powershell` and `replxx` import subcommands** These importers were introduced in PRs [atuinsh/atuin#2864](https://github.com/atuinsh/atuin/pull/2864) and [atuinsh/atuin#2024](https://github.com/atuinsh/atuin/pull/2024), respectively, but the documentation was not updated to account for them. 3. **Fix alphabetic sorting of sections** Move the `nu-hist-db` and `zsh-hist-db` sections to be after `nu` and `zsh`, respectively. This is more intuitive, and matches the existing sort used for the `xonsh` / `xonsh-sqlite` sections. 4. **Minor whitespace correction** Fix line wrapping in the `resh` section ~~and remove trailing whitespace in the `nu*` sections.~~ <!-- Thank you for making a PR! Bug fixes are always welcome, but if you're adding a new feature or changing an existing one, we'd really appreciate if you open an issue, post on the forum, or drop in on Discord --> ## Checks - [x] I am happy for maintainers to push small adjustments to this PR, to speed up the review cycle - [x] I have checked that there are no existing pull requests for the same thing Fixes #2533.
* Theming: explain how to set ANSI codes directly (#3065)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/109 **Original author:** @philtweir --- ### What is the purpose of this pull request? Short change to note that there is a supported way of directly setting ANSI codes, and other Crossterm colours, directly using the `@` symbol. ### Why is this relevant? This could provide a workaround for issues such as https://github.com/atuinsh/atuin/issues/2827, where a 256 colour terminal shows all themes as grey. Co-authored-by: Phil Weir <phil.weir@flaxandteal.co.uk> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs(installation): add mise alternative installation method (#3066)Michelle Tilley2026-01-16
| | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/108 **Original author:** @jylenhof --- *Original PR had no description.* Signed-off-by: jylenhof <jygithub@lenhof.eu.org> Co-authored-by: jylenhof <jygithub@lenhof.eu.org> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Extend sync login flag documentation (#3067)Michelle Tilley2026-01-16
| | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/107 **Original author:** @PythonGermany --- Explicitly mention that it is also possible to omit secret key flag when logging in. Co-authored-by: PythonGermany <97847597+PythonGermany@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Add jj to common_subcommands (#3068)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/105 **Original author:** @wetheredge --- See <https://github.com/atuinsh/atuin/pull/2708> Co-authored-by: Wren Etheredge <me@wetheredge.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* document keys.exit_past_line_{start,end} (#3071)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/95 **Original author:** @russmatney --- The newly introduced behavior was driving me crazy! But I was happy to find it was already configurable. Here's an update to the docs, per: https://github.com/atuinsh/atuin/pull/2606#pullrequestreview-2669540017 Co-authored-by: Russell Matney <russell.matney@gmail.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Document key binding issue on Ghostty for Linux (#3073)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/89 **Original author:** @matthewberryman --- *Original PR had no description.* Co-authored-by: Matthew Berryman <matthew@acrossthecloud.net> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Update installation.mdx (#3078)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/73 **Original author:** @MustCodeAl --- - Added [Antidote plugin manager](https://github.com/mattmc3/antidote) install instructions - Added instructions for [Zsh-Vi-Mode](https://github.com/jeffreytse/zsh-vi-mode) - Fixed formatting on zsh-autosuggestions Co-authored-by: Albert <87888006+MustCodeAl@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* feat(ultracompact): Adds setting for ultracompact mode (#3079)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/72 **Original author:** @philtweir --- ### What does this PR do? Adds the `auto_hide_height` setting to enable/disable/configure ultracompact mode when fewer than a minimum number of lines are available and the `compact` style has been configured. The new keybindings for the inspector are outlined also. Notes the new `(none)` theme, which will be used for functional code-tests and as a fallback when the requested theme is unloadable. Corresponds to: https://github.com/atuinsh/atuin/pull/2319 Co-authored-by: Phil Weir <phil.weir@flaxandteal.co.uk> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* feat(theme): Note new default theme name and syntax (#3080)Michelle Tilley2026-01-16
| | | | | | | | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/71 **Original author:** @philtweir --- ## What does this PR do? * corrects the default theme name from `""` to `"default"` * highlights the `@` color name in syntax * explains the new _Meaning_: `Muted` * comments on the (current) limitation of not being able to explicitly "unset" the foreground Co-authored-by: Phil Weir <phil.weir@flaxandteal.co.uk> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs(config): clarify scope of directory filter_mode (#3082)Michelle Tilley2026-01-16
| | | | | | | | | | | | Clarify that the directory filter_mode searches across all hosts/sessions, just filtering by directory path. --- Migrated from https://github.com/atuinsh/docs/pull/67 Original author: @tessarek Co-authored-by: Helmut K. C. Tessarek <tessarek@evermeet.cx> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* Small spelling fix (#3081)Michelle Tilley2026-01-16
| | | | | | | | | | | | **Migrated from atuinsh/docs PR:** https://github.com/atuinsh/docs/pull/70 **Original author:** @andyfoster --- *Original PR had no description.* Co-authored-by: Andy <andyfoster@users.noreply.github.com> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
* docs: Migrate docs from separate repo to `docs` subfolder (#3018)Michelle Tilley2025-12-12
|
* ci: use native github arm64 runner (#2690)Devin Buhl2025-04-09
| | | | | | | | | | | * ci: use native github arm64 runner Signed-off-by: Devin Buhl <devin@buhl.casa> * Update README.md --------- Signed-off-by: Devin Buhl <devin@buhl.casa>
* docs: update logo and badges in README for zh-CN (#2392)Zhizhen He2025-03-24
|
* docs: fix "From source" `cd` command (#1973)Richard de Boer2024-04-22
| | | `atuin` was moved into the `crates/` directory in 95cc4720
generated by cgit v1.3.1 (git 2.54.0) at 2026-06-15 13:30:03 +0000