kitty - kitty Documentation
kitty [options] [program-to-run ...]
Run the kitty terminal emulator. You can also specify the program
to run inside kitty as normal arguments following the options. For example:
kitty /bin/sh
For comprehensive documentation for kitty, please see:
https://sw.kovidgoyal.net/kitty
- --class
<CLS>
- Set the class part of the WM_CLASS window property. On Wayland, it sets
the app id. Default: kitty
- --name
<NAME>
- Set the name part of the WM_CLASS property (defaults to using the value
from kitty --class)
- --title <TITLE>, -T
<TITLE>
- Set the window title. This will override any title set by the program
running inside kitty. So only use this if you are running a program that
does not set titles. If combined with kitty --session the title
will be used for all windows created by the session, that do not set their
own titles.
- --config
<CONFIG>, -c <CONFIG>
- Specify a path to the configuration file(s) to use. All configuration
files are merged onto the builtin kitty.conf, overriding the builtin
values. This option can be specified multiple times to read multiple
configuration files in sequence, which are merged. Use the special value
NONE to not load a config file.
If this option is not specified, config files are searched for
in the order: $XDG_CONFIG_HOME/kitty/kitty.conf,
~/.config/kitty/kitty.conf,
$XDG_CONFIG_DIRS/kitty/kitty.conf. The first one that exists is
used as the config file.
If the environment variable KITTY_CONFIG_DIRECTORY is
specified, that directory is always used and the above searching does
not happen.
If /etc/xdg/kitty/kitty.conf exists it is merged before
(i.e. with lower priority) than any user config files. It can be used to
specify system-wide defaults for all users.
- --detach
- Detach from the controlling terminal, if any
- --session
<SESSION>
- Path to a file containing the startup session (tabs, windows, layout,
programs). See the README file for details and an example.
- --hold
- Remain open after child process exits. Note that this only affects the
first window. You can quit by either using the close window shortcut or
Ctrl+d.
- --single-instance,
-1
- If specified only a single instance of kitty will run. New invocations
will instead create a new top-level window in the existing kitty instance.
This allows kitty to share a single sprite cache on the GPU and also
reduces startup time. You can also have separate groups of kitty instances
by using the kitty --instance-group option
- --instance-group
<INSTANCE_GROUP>
- Used in combination with the kitty --single-instance option. All
kitty invocations with the same kitty --instance-group will result
in new windows being created in the first kitty instance within that
group
- --wait-for-single-instance-window-close
- Normally, when using --single-instance, kitty will open a new
window in an existing instance and quit immediately. With this option, it
will not quit till the newly opened window is closed. Note that if no
previous instance is found, then kitty will wait anyway, regardless of
this option.
- --listen-on
<LISTEN_ON>
- Tell kitty to listen on the specified address for control messages. For
example, kitty --listen-on=unix:/tmp/mykitty or kitty
--listen-on=tcp:localhost:12345. On Linux systems, you can also
use abstract UNIX sockets, not associated with a file, like this: kitty
--listen-on=unix:@mykitty. To control kitty, you can send it
commands with kitty @ using the kitty @ --to option to specify this
address. This option will be ignored, unless you set
allow_remote_control to yes in kitty.conf. Note that if you
run kitty @ within a kitty window, there is no need to specify the --to
option as it is read automatically from the environment.
- --start-as
<START_AS>
- Control how the initial kitty window is created. Default: normal
Choices: fullscreen, maximized, minimized, normal
- --replay-commands
<REPLAY_COMMANDS>
- Replay previously dumped commands. Specify the path to a dump file
previously created by --dump-commands. You can open a new kitty window to
replay the commands with:
kitty sh -c "kitty --replay-commands /path/to/dump/file; read"
- --debug-gl
- Debug OpenGL commands. This will cause all OpenGL calls to check for
errors instead of ignoring them. Useful when debugging rendering
problems
- --debug-keyboard
- This option will cause kitty to print out key events as they are
received
- --debug-font-fallback
- Print out information about the selection of fallback fonts for characters
not present in the main font.
- --debug-config
- Print out information about the system and kitty configuration.