mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-17 05:54:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document the new run-shell kitten

Browse Source
This commit is contained in:
Kovid Goyal
2023-06-26 10:47:13 +05:30
parent 7e35ee33e3
commit 01b55a5522
3 changed files with 30 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/shell-integration.rst
View File

@@ -292,6 +292,30 @@ In order to avoid remote code execution, kitty will only execute the configured
editor and pass the file path to edit to it.
.. _run_shell:
Using shell integration in sub-shells, containers, etc.
-----------------------------------------------------------
To start a sub-shell with shell integration automatically setup, simply run::
kitten run-shell
This will start a sub-shell using the same binary as the currently running
shell, with shell-integration enabled. To start a particular shell use::
kitten run-shell --shell=/bin/bash
To run a command before starting the shell use::
kitten run-shell ls .
This will run ``ls .`` before starting the shell.
This will even work on remote systems where kitty itself is not installed,
provided you use the :doc:`SSH kitten <kittens/ssh>` to connect to the system.
Use ``kitten run-shell --help`` to learn more.
.. _manual_shell_integration:
Manual shell integration
@@ -299,8 +323,8 @@ Manual shell integration
The automatic shell integration is designed to be minimally intrusive, as such
it won't work for sub-shells, terminal multiplexers, containers, etc.
For such systems, you should setup manual shell integration by adding some code
to your shells startup files to load the shell integration script.
For such systems, you should either use the :ref:`run-shell <run_shell>` command described above or
setup manual shell integration by adding some code to your shells startup files to load the shell integration script.
First, in :file:`kitty.conf` set: