diff --git a/docs/changelog.rst b/docs/changelog.rst index eba198b96..2b01cb6aa 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -11,6 +11,9 @@ To update |kitty|, :doc:`follow the instructions `. `_. Controlled via :opt:`allow_hyperlinks` (:iss:`68`) +- Add support for easily editing or downloading files over SSH sessions + without the need for any special software, see :doc:`kittens/remote_file` + - Improve rendering of borders when using minimal borders. Use less space and do not display a box around active windows diff --git a/docs/kittens/remote_file.rst b/docs/kittens/remote_file.rst new file mode 100644 index 000000000..71aaafcd9 --- /dev/null +++ b/docs/kittens/remote_file.rst @@ -0,0 +1,30 @@ +Remote files +============== + +|kitty| has the ability to easily *Edit*, *Open* or *Download* files +from a computer into which you are SSHed. In your SSH session run:: + + ls --hyperlink=auto + +Then hold down :kbd:`ctrl+shift` and click the name of the file. + +.. figure:: ../screenshots/remote_file.png + :alt: Remote file actions + :align: center + :scale: 100% + + Remote file actions + +|kitty| will ask you what you want to do with the remote file. You can choose +to *Edit* it in which case kitty will download it and open it locally in your +``EDITOR``. As you make changes to the file, they are automatically transferred +to the remote computer. Note that this happens without needing to install *any* +special software on the server, beyond ``ls`` that supports hyperlinks. + +.. note:: + If you have not setup automatic password-less SSH access, then, when + editing starts you will be asked to enter your password just once, + thereafter the SSH connection will be re-used. + +Similarly, you can choose to save the file to the local computer or download +and open it in its default file handler. diff --git a/docs/screenshots/remote_file.png b/docs/screenshots/remote_file.png new file mode 100644 index 000000000..e5d684d2d Binary files /dev/null and b/docs/screenshots/remote_file.png differ