diff options
| author | Michelle Tilley <michelle@michelletilley.net> | 2026-02-11 16:17:13 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-02-11 16:17:13 -0800 |
| commit | f8a1121e7723943503d426c05ce0b96b277fab81 (patch) | |
| tree | 4f6515ba39dd095c43a9ce056cac6e43cdc3acab /docs/mkdocs.yml | |
| parent | feat: `switch-context` (#3149) (diff) | |
| download | atuin-f8a1121e7723943503d426c05ce0b96b277fab81.zip | |
feat(docs): Add Shell Integration and Interoperability docs (#3163)
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>
Diffstat (limited to '')
| -rw-r--r-- | docs/mkdocs.yml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 4ca51c60..26bf0bee 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -64,6 +64,7 @@ nav: - Import existing history: guide/import.md - Basic usage: guide/basic-usage.md - Advanced usage: guide/advanced-usage.md + - Shell Integration: guide/shell-integration.md - Deleting history: guide/delete-history.md - Syncing dotfiles: guide/dotfiles.md - Theming: guide/theming.md |