aboutsummaryrefslogtreecommitdiffstats
path: root/docs (follow)
Commit message (Collapse)AuthorAge
* 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
* feat(zsh): update widget names (#1631)Koichi Murase2024-01-29
| | | | | | | | | | | | | | | | | | The current widget names for Zsh start with "_", which gives an impression to users that those widgets are internal API and should not be bound by the users. However, we actually instruct users to set up custom keybindings by specifying them to bindkey. In other shells, a separate namespace for widgets are not prepared, so we want to prefix "_" to shell function names to tell the users that these are not the commands that are supposed to be called from the command line. However, the widget names are separated in their own namespace in Zsh, so we do not have to isolate them by prefixing "_". In fact, other frameworks such as `fzf` define widgets with names not starting with "_". In this patch, we update the widget names to have the form "atuin-*". The old widget names that existed in the release version <= 17.2.1 are left for compatibility.
* docs: remove old docusaurus (#1581)Ellie Huxtable2024-01-16
|
* feat(ui): vim mode (#1553)YummyOreo2024-01-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * feat(config): add vim option to config * feat(ui): simple vim mode * fix(windows): windows sadly doesn't support the stuff * feat(ui): blinking * fix(merge) * revert: reverts some debugging stuff * feat(ui): changes the defaut to insert, don't know what should be the default * feat(ui): implements some vim parity * doc: adds this to the docs * docs(keybindings): adds vim mode keybindsings to the list of keybindings * refactor: rustfmt and remove the docs for pr in own repo * refactor: use execute! * Update atuin/src/command/client/search/interactive.rs --------- Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
* docs: refer to image with multi-arch support (#1513)Matthew Berryman2024-01-08
|
* feat: include atuin login in secret patterns (#1518)Matthew Berryman2024-01-08
| | | | | * include atuin login in secret patterns * doc catchup
* feat(bash): provide auto-complete source for ble.sh (#1487)Koichi Murase2024-01-02
| | | | | * feat(bash): provide auto-complete source for ble.sh * docs(integration): mention the auto-complete source for ble.sh
* docs: update logo (#1481)Ellie Huxtable2024-01-01
|
* docs: add docs for zsh-autosuggestion integration (#1480)Ellie Huxtable2024-01-01
| | | | I've added an integrations page to the docs. We can maintain a list of such integrations
* feat: Add TLS to atuin-server (#1457)Eric Hodel2023-12-27
| | | | | | | | | | | | | | | | | | | | * Add TLS to atuin-server atuin as a project already includes most of the dependencies necessary for server-side TLS. This allows `atuin server start` to use a TLS certificate when self-hosting in order to avoid the complication of wrapping it in a TLS-aware proxy server. Configuration is handled similar to the metrics server with its own struct and currently accepts only the private key and certificate file paths. Starting a TLS server and a TCP server are divergent because the tests need to bind to an arbitrary port to avoid collisions across tests. The API to accomplish this for a TLS server is much more verbose. * Fix clippy, fmt * Add TLS section to self-hosting
* docs: correct linkEllie Huxtable2023-12-14
|
* docs: add fish install script (#1447)Ellie Huxtable2023-12-14
|
* docs: add Void Linux install instruction (#1445)Marcin Puc2023-12-14
| | | | | * docs(readme): add Void Linux install instruction * docs: add Void Linux install instruction to advanced-install.md
* docs: align setup links in docs and readme (#1446)Ellie Huxtable2023-12-14
|
* docs: new stats config (#1412)Ellie Huxtable2023-11-23
|
* docs: Update Arch Linux package URL in advanced-install.md (#1407)Felix Yan2023-11-23
| | | The old URL returns 404 now.
* docs: Update sync.md (#1409)镜面王子2023-11-22
| | | Linux name correction
* Bash `enter_accept` best effort fixes (#1384)Patrick Jackson2023-11-10
| | | | | * fix(bash): Rewrite the enter_accept integration * docs(bash): Update bash installation instructions with warnings
* Update docs (#1367)Ellie Huxtable2023-11-01
|
* Add release blog post and update docs (#1332)Ellie Huxtable2023-10-26
| | | | | | | * Add release blog post and update docs * I forgot I moved the blog lmao * Fix images
* fix(nu): disable the up-arrow keybinding for Nushell (#1329)Patrick Jackson2023-10-26
|
* Document that the self-hosted port is TCP (#1317)Nemo1572023-10-21
|
* Add fish support for `enter_accept` (#1315)Ellie Huxtable2023-10-20
| | | | | | | | * Add fish support for `enter_accept` Also fixes shell detection. Who trusted me to write jetlagged code last night huh? * Document
* Add enter_accept to immediately execute an accepted command (#1311)Ellie Huxtable2023-10-20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * make enter execute the command, tab copy it * Add config for enter_accept enter_accept will make Atuin immediately accept an execute a command when selected. It defaults to false in our binary, but the default config enables it. This means that users who already use atuin will not default to the new behaviour unless they opt in, but new users will have it by default. Thanks to @davidhewitt for the patch and bulk of this implementation! Currently we have it just for zsh, but I'll follow up with other shells (unless anyone beats me to it :D) * Add docs * we need to tidy up the ui code anyway * Check if using zsh * Update docs/docs/config/config.md Co-authored-by: Conrad Ludgate <conradludgate@gmail.com> --------- Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>
* Bump @babel/traverse from 7.21.2 to 7.23.2 in /docs (#1309)dependabot[bot]2023-10-17
| | | | | | | | | | | | | | | Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.21.2 to 7.23.2. - [Release notes](https://github.com/babel/babel/releases) - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md) - [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse) --- updated-dependencies: - dependency-name: "@babel/traverse" dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Update key binding docsEllie Huxtable2023-10-14
|
* Update key-binding.md (#1291)Evan McBeth2023-10-09
| | | added some info about FISH and how to bind the CTRL-up keyset.
* Fix/1207 deleted entries shown in interactive search (#1272)Dieter Eickstaedt2023-10-04
|
* feat: copy to clipboard (#1249)YummyOreo2023-09-30
| | | | | | | * feat: adds clipboard as a dep * feat: add copy if you press ctl+y * docs: add copy to clipboard to docs
* add --reverse to history list (#1252)Chandra Kiran G2023-09-29
| | | | | | | | | | | | | | | | | | | * wip: add --reverse to history list * fix: remove print_list being called twice when reverse=true * chore: update documentation * feat: Avoid unneeded reverse by iterate forward or backward instead * feat: Make sure to only iterate once and avoid unneeded reverse call * feat: It used to be reverse by default. So make it default true here to be backwards compatible * fix clap --------- Co-authored-by: Dieter Eickstädt <eickstaedt@deicon.de>
generated by cgit v1.3.1 (git 2.54.0) at 2026-06-14 13:49:02 +0000