KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add an example of using the remote control protocol from a shell script

Browse Source
This commit is contained in:
Kovid Goyal 2021-01-04 12:17:20 +05:30
parent 2762488c81
commit c55f485166
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/rc_protocol.rst
View File

@ -26,4 +26,16 @@ Set ``no_response`` to ``true`` if you don't want a response from kitty.
The optional payload is a JSON object that is specific to the actual command being sent. The optional payload is a JSON object that is specific to the actual command being sent.
The fields in the object for every command are documented below. The fields in the object for every command are documented below.
As a quick example showing how easy to use this protocol is, we will implement
the ``@ ls`` command from the shell using only shell tools. First, run kitty
as::
kitty -o allow_remote_control=socket-only --listen-on unix:/tmp/test
Now, in a different terminal, you can get the pretty printed ``@ ls`` output
with the following command line::
echo -n '\x1bP@kitty-cmd{"cmd":"ls","version":[0,14,2]}\x1b\' | socat - unix:/tmp/test | tail -c +13 | jq -c '.data | fromjson' 2>/dev/null | jq .
.. include:: generated/rc.rst .. include:: generated/rc.rst