diff options
| author | Ian Chesal <ian.chesal@gmail.com> | 2024-05-28 17:40:30 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-28 14:40:30 -0700 |
| commit | 071b8f8921cb2bbb1fcabbf3d271e77af0b12a7d (patch) | |
| tree | 8658b4ae28eb33e6046433a1a4e21aadcb04c91b /plugins/kitty/README.md | |
| parent | 5e59d21e5465ec0694441f41ff0acf1ddf4de187 (diff) | |
| download | zsh-071b8f8921cb2bbb1fcabbf3d271e77af0b12a7d.tar.gz zsh-071b8f8921cb2bbb1fcabbf3d271e77af0b12a7d.tar.bz2 zsh-071b8f8921cb2bbb1fcabbf3d271e77af0b12a7d.zip | |
feat(kitty): add plugin for the kitty terminal (#10994)
* A plugin for the Kitty terminal
Provides a handful of useful aliases for anyone working in a Kitty
terminal. In particular, the kssh command is handy for ensuring that
terminfo is set correctly on remote hosts when you ssh to them.
* Guard kitty configuration
We should only load these aliases into a terminal that's identifying
itself as an xterm-kitty terminal. They're not useful in any other
situation.
Diffstat (limited to 'plugins/kitty/README.md')
| -rw-r--r-- | plugins/kitty/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/kitty/README.md b/plugins/kitty/README.md new file mode 100644 index 000000000..ec9e375de --- /dev/null +++ b/plugins/kitty/README.md @@ -0,0 +1,23 @@ +# Kitty plugin + +This plugin adds a few aliases and functions that are useful for users of the [Kitty](https://sw.kovidgoyal.net/kitty/) terminal. + +To use it, add _kitty_ to the plugins array of your zshrc file: +``` +plugins=(... kitty) +``` + +## Plugin commands + +* `kssh` + Runs a kitten ssh session that ensures your terminfo settings are copied + correctly to the remote hose. +* `kssh-slow` + A slower form of `kssh` that should always work. Use this if `kssh` fails + to set terminfo correctly for you on the remote host. +* `kitty-theme` + Browse and change the theme of your Kitty terminal. + +## Contributors + +- [Ian Chesal](https://github.com/ianchesal) |