mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-06-12 19:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add the SSH kitten to the Changelog

Browse Source
This commit is contained in:
Kovid Goyal
2022-03-18 10:45:16 +05:30
parent 66fe53ceb1
commit e791a8a7bb
3 changed files with 34 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/kittens/ssh.rst
View File

@@ -1,6 +1,12 @@
Truly convenient SSH
=========================================
* Automatic :ref:`shell_integration` on remote machines
* Easily :ref:`clone local shell/editor config <real_world_ssh_kitten_config>` on remote machines
* Automatic :opt:`re-use of existing connections <kitten-ssh.share_connections>` to avoid connection setup latency
The ssh kitten allows you to login easily to remote servers, and automatically
setup the environment there to be as comfortable as your local shell. You
can specify environment variables to set on the remote server and
@@ -77,6 +83,8 @@ by this invocation, so any :opt:`hostname <kitten-ssh.hostname>` directives are
the shell prompt 😇.
.. _real_world_ssh_kitten_config:
A real world example
----------------------
@@ -108,17 +116,17 @@ How it works
----------------
The ssh kitten works by having SSH transmit and execute a POSIX sh (or
optionally Python) bootstrap script on the remote server using an
:opt:`interpreter <kitten-ssh.interpreter>`. This script reads setup data over
the tty device, which kitty sends as a base64 encoded tarball. The script
extracts it and places the :opt:`files <kitten-ssh.copy>` and sets the
:opt:`environment variables <kitten-ssh.env>` before finally launching the
:opt:`login shell <kitten-ssh.login_shell>` with shell integration enabled. The
data is requested by the kitten over the TTY with a random one time password.
kitty reads the request and if the password matches a password pre-stored in
shared memory on the localhost by the kitten, the transmission is allowed. If
your OpenSSH version is >= 8.4 then the data is transmitted instantly without
any roundtrip delay.
:opt:`optionally <kitten-ssh.interpreter>` Python) bootstrap script on the
remote server using an :opt:`interpreter <kitten-ssh.interpreter>`. This script
reads setup data over the tty device, which kitty sends as a base64 encoded
compressed tarball. The script extracts it and places the :opt:`files <kitten-ssh.copy>`
and sets the :opt:`environment variables <kitten-ssh.env>` before finally
launching the :opt:`login shell <kitten-ssh.login_shell>` with shell
integration enabled. The data is requested by the kitten over the TTY with a
random one time password. kitty reads the request and if the password matches
a password pre-stored in shared memory on the localhost by the kitten, the
transmission is allowed. If your OpenSSH version is >= 8.4 then the data is
transmitted instantly without any roundtrip delay.
.. note::