diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/docs/guide/installation.md | 10 | ||||
| -rw-r--r-- | docs/docs/reference/hex.md | 66 | ||||
| -rw-r--r-- | docs/docs/reference/pty-proxy.md | 69 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 5 |
4 files changed, 78 insertions, 72 deletions
diff --git a/docs/docs/guide/installation.md b/docs/docs/guide/installation.md index d17a508b..7fe69130 100644 --- a/docs/docs/guide/installation.md +++ b/docs/docs/guide/installation.md @@ -260,21 +260,21 @@ After installing, remember to restart your shell. source ~/.local/share/atuin/init.nu ``` - ??? tip "Optional: Atuin Hex" - Hex is a lightweight pty proxy that renders the Atuin popup over + ??? tip "Optional: Atuin pty-proxy" + pty-proxy is a lightweight pty proxy that renders the Atuin popup over your previous output, restoring it when closed — no clearing, no - fullscreen. To use Hex with Nushell, generate the init script: + fullscreen. To use pty-proxy with Nushell, generate the init script: ```shell mkdir ~/.local/share/atuin/ - atuin hex init nu | save -f ~/.local/share/atuin/hex-init.nu + atuin pty-proxy init nu | save -f ~/.local/share/atuin/pty-proxy-init.nu ``` Then source it as early as possible in your `config.nu`, *before* the regular atuin init: ```shell - source ~/.local/share/atuin/hex-init.nu + source ~/.local/share/atuin/pty-proxy-init.nu source ~/.local/share/atuin/init.nu ``` diff --git a/docs/docs/reference/hex.md b/docs/docs/reference/hex.md index 1bbf9336..8bffed68 100644 --- a/docs/docs/reference/hex.md +++ b/docs/docs/reference/hex.md @@ -1,65 +1 @@ -# hex - -Atuin Hex is an experimental lightweight PTY proxy, providing new features without needing to replace your existing terminal or shell. Atuin Hex currently supports bash, zsh, fish, and nu. - -## TUI Rendering - -The search TUI exposes a tradeoff: the UI is either in fullscreen alt-screen mode that takes over your terminal, or inline mode that clears your previous output. Neither is great. - -With Hex, we can have our cake AND eat it too. The Atuin popup renders over the top of your previous output, but when it's closed we can restore the output successfully. - -## Initialization - -Atuin Hex needs to be initialized separately from your existing Atuin config. Place the init line shown below in your shell's init script, as high in the document as possible, *before* your normal `atuin init` call. - -=== "zsh" - - ```shell - eval "$(atuin hex init zsh)" - ``` - -=== "bash" - - ```shell - eval "$(atuin hex init bash)" - ``` - -=== "fish" - - Add - - ```shell - atuin hex init fish | source - ``` - - to your `is-interactive` block in your `~/.config/fish/config.fish` file - -=== "Nushell" - - Run in *Nushell*: - - ```shell - mkdir ~/.local/share/atuin/ - atuin hex init nu | save -f ~/.local/share/atuin/hex-init.nu - ``` - - Add to `config.nu`, **before** the regular `atuin init`: - - ```shell - source ~/.local/share/atuin/hex-init.nu - ``` - Nushell's `source` command requires a static file path, so you must - pre-generate the file. - ---- - -If the `atuin` binary is not in your `PATH` by default, you should initialize Hex as soon as it is set. For example, for a bash user with Atuin installed in `~/.atuin/bin/atuin`, a config file might look like this: - -```bash -export PATH=$HOME/.atuin/bin:$PATH -eval "$(atuin hex init bash)" - -# ... other shell configuration ... - -eval "$(atuin init bash)" -``` +`atuin hex` has been renamed `atuin pty-proxy` as of Atuin v18.17.0. diff --git a/docs/docs/reference/pty-proxy.md b/docs/docs/reference/pty-proxy.md new file mode 100644 index 00000000..ce4a881f --- /dev/null +++ b/docs/docs/reference/pty-proxy.md @@ -0,0 +1,69 @@ +# pty-proxy + +Atuin pty-proxy is an experimental lightweight PTY proxy, providing new features without needing to replace your existing terminal or shell. It currently supports bash, zsh, fish, and nu. + +!!! Note "Previously `atuin hex`" + + `atuin pty-proxy` is a replacement for the old `atuin hex` command. `atuin hex` still works for backward compatibility reasons, but will eventually be removed. + +## TUI Rendering + +The search TUI exposes a tradeoff: the UI is either in fullscreen alt-screen mode that takes over your terminal, or inline mode that clears your previous output. Neither is great. + +With pty-proxy, the Atuin popup renders over the top of your previous output, but when it's closed we can restore the output successfully. + +## Initialization + +Atuin pty-proxy needs to be initialized separately from your existing Atuin config. Place the init line shown below in your shell's init script, as high in the document as possible, _before_ your normal `atuin init` call. + +=== "zsh" + + ```shell + eval "$(atuin pty-proxy init zsh)" + ``` + +=== "bash" + + ```shell + eval "$(atuin pty-proxy init bash)" + ``` + +=== "fish" + + Add + + ```shell + atuin pty-proxy init fish | source + ``` + + to your `is-interactive` block in your `~/.config/fish/config.fish` file + +=== "Nushell" + + Run in *Nushell*: + + ```shell + mkdir ~/.local/share/atuin/ + atuin pty-proxy init nu | save -f ~/.local/share/atuin/pty-proxy-init.nu + ``` + + Add to `config.nu`, **before** the regular `atuin init`: + + ```shell + source ~/.local/share/atuin/pty-proxy-init.nu + ``` + Nushell's `source` command requires a static file path, so you must + pre-generate the file. + +--- + +If the `atuin` binary is not in your `PATH` by default, you should initialize pty-proxy as soon as it is set. For example, for a bash user with Atuin installed in `~/.atuin/bin/atuin`, a config file might look like this: + +```bash +export PATH=$HOME/.atuin/bin:$PATH +eval "$(atuin pty-proxy init bash)" + +# ... other shell configuration ... + +eval "$(atuin init bash)" +``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 2742fdb0..b0fb2491 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -75,7 +75,8 @@ plugins: - reference/daemon.md: Background daemon for faster writes, auto-sync, and in-memory fuzzy search. - reference/doctor.md: Diagnose common problems and dump system info for bug reports. - reference/gen-completions.md: Generate shell completions for bash, fish, zsh, nushell, powershell, elvish. - - reference/hex.md: Experimental PTY proxy with popup rendering over existing terminal output. + - reference/hex.md: The old name for `atuin pty-proxy` + - reference/pty-proxy.md: Experimental PTY proxy with popup rendering over existing terminal output. - reference/import.md: Import history from bash, fish, zsh, replxx, mcfly, resh, and xonsh. - reference/info.md: Show config file paths, env vars, and version info. - reference/list.md: List history entries with formatting, filtering by cwd/session, and custom output templates. @@ -141,7 +142,7 @@ nav: - daemon: reference/daemon.md - doctor: reference/doctor.md - gen-completions: reference/gen-completions.md - - hex: reference/hex.md + - pty-proxy: reference/pty-proxy.md - import: reference/import.md - info: reference/info.md - history list: reference/list.md |