Skip to content

Commit

Permalink
chore: add note about only supporting zsh 5.9+
Browse files Browse the repository at this point in the history
  • Loading branch information
mikesmithgh committed Dec 18, 2024
1 parent 711b042 commit 1249809
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,8 @@ The API is available via the `kitty-scrollback.api` module. e.g., `require('kitt

> [!NOTE]
> Command-line editing is only supported for `bash`, `fish`, or `zsh`
> Only `zsh` version 5.9 or greater is supported by kitty-scrollback.nvim for command-line editing. If you are using `zsh`,
> please confirm you have a compatible version by running `zsh --version`
Generate the configuration and add it to the appropriate location. The comments in the configuration will provide
additional setup instructions. `KittyScrollbackGenerateCommandLineEditing` requires one parameter, either `bash`, `fish`, or `zsh`.
Expand Down Expand Up @@ -995,6 +997,9 @@ command-line buffer in the editor defined in the `VISUAL` environment variable.
- Run `nvim --headless +'KittyScrollbackGenerateCommandLineEditing zsh'`. You should see similar output to the following:

```zsh
# IMPORTANT: kitty-scrollback.nvim only supports zsh 5.9 or greater for command-line editing,
# please check your version by running: zsh --version

# add the following environment variables to your zsh config (e.g., ~/.zshrc)

autoload -Uz edit-command-line
Expand Down
3 changes: 3 additions & 0 deletions lua/kitty-scrollback/api.lua
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,9 @@ M.generate_command_line_editing = function(shell)
[[]],
},
zsh = {
[[# IMPORTANT: kitty-scrollback.nvim only supports zsh 5.9 or greater for command-line editing,]],
[[# please check your version by running: zsh --version]],
[[]],
[[# add the following environment variables to your zsh config (e.g., ~/.zshrc)]],
[[]],
[[autoload -Uz edit-command-line]],
Expand Down

0 comments on commit 1249809

Please sign in to comment.