2200 lines
77 KiB
Plaintext
2200 lines
77 KiB
Plaintext
# vim:fileencoding=utf-8:foldmethod=marker
|
|
|
|
#: Fonts {{{
|
|
|
|
font_family JetBrainsMono Nerd Font
|
|
bold_font JetBrainsMono Nerd Font
|
|
italic_font JetBrainsMono Nerd Font
|
|
bold_italic_font JetBrainsMono Nerd Font
|
|
# Delugia
|
|
# Operator Mono SSm Lig Book Italic
|
|
font_size 10
|
|
|
|
force_ltr no
|
|
|
|
adjust_line_height 125%
|
|
# adjust_column_width 100%
|
|
|
|
# adjust_baseline 0
|
|
|
|
# symbol_map U+E000-U+FF63 FiraCode Nerd Font
|
|
# symbol_map U+EB62,U+EA88,U+EB5B,U+EB65,U+EB36,U+EA8A,U+EB8D codicon
|
|
|
|
disable_ligatures never
|
|
|
|
# font_features none
|
|
|
|
#: font_features FiraCode-Retina +zero +onum
|
|
|
|
#: font_features TT2020StyleB-Regular -liga +calt
|
|
|
|
#: font_features UnifontMedium +isol -medi -fina -init
|
|
|
|
# box_drawing_scale 0.001, 1, 1.5, 2
|
|
|
|
#: Change the sizes of the lines used for the box drawing unicode
|
|
#: characters These values are in pts. They will be scaled by the
|
|
#: monitor DPI to arrive at a pixel value. There must be four values
|
|
#: corresponding to thin, normal, thick, and very thick lines.
|
|
|
|
#: }}}
|
|
|
|
#: Cursor customization {{{
|
|
|
|
cursor #bbbbbb
|
|
|
|
# cursor_text_color #111111
|
|
|
|
cursor_shape beam
|
|
|
|
cursor_beam_thickness 1
|
|
|
|
# cursor_underline_thickness 2.0
|
|
|
|
# cursor_blink_interval -1
|
|
|
|
# cursor_stop_blinking_after 15.0
|
|
|
|
#: }}}
|
|
|
|
#: Scrollback {{{
|
|
|
|
scrollback_lines 50000
|
|
|
|
scrollback_pager less -R -F
|
|
|
|
# scrollback_pager_history_size 0
|
|
|
|
# scrollback_fill_enlarged_window no
|
|
|
|
wheel_scroll_multiplier 2.0
|
|
|
|
# touch_scroll_multiplier 1.0
|
|
|
|
#: }}}
|
|
|
|
#: Mouse {{{
|
|
|
|
mouse_hide_wait 3.0
|
|
|
|
url_color #0078d7
|
|
url_style single
|
|
|
|
open_url_with default
|
|
|
|
url_prefixes http https file ftp gemini irc gopher mailto news git
|
|
|
|
detect_urls yes
|
|
|
|
# url_excluded_characters
|
|
|
|
copy_on_select no
|
|
|
|
strip_trailing_spaces always
|
|
|
|
# select_by_word_characters @-./_~?&=%+#
|
|
|
|
#: Characters considered part of a word when double clicking. In
|
|
#: addition to these characters any character that is marked as an
|
|
#: alphanumeric character in the unicode database will be matched.
|
|
|
|
# click_interval -1.0
|
|
|
|
focus_follows_mouse no
|
|
|
|
pointer_shape_when_grabbed hand
|
|
|
|
default_pointer_shape arrow
|
|
|
|
pointer_shape_when_dragging beam
|
|
|
|
#: Mouse actions {{{
|
|
|
|
#: Mouse buttons can be remapped to perform arbitrary actions. The
|
|
#: syntax for doing so is:
|
|
|
|
#: .. code-block:: none
|
|
|
|
#: mouse_map button-name event-type modes action
|
|
|
|
#: Where ``button-name`` is one of ``left``, ``middle``, ``right`` or
|
|
#: ``b1 ... b8`` with added keyboard modifiers, for example:
|
|
#: ``ctrl+shift+left`` refers to holding the ctrl+shift keys while
|
|
#: clicking with the left mouse button. The number ``b1 ... b8`` can
|
|
#: be used to refer to upto eight buttons on a mouse.
|
|
|
|
#: ``event-type`` is one ``press``, ``release``, ``doublepress``,
|
|
#: ``triplepress``, ``click`` and ``doubleclick``. ``modes``
|
|
#: indicates whether the action is performed when the mouse is grabbed
|
|
#: by the program running in the terminal, or not. It can have one or
|
|
#: more or the values, ``grabbed,ungrabbed``. ``grabbed`` refers to
|
|
#: when the program running in the terminal has requested mouse
|
|
#: events. Note that the click and double click events have a delay of
|
|
#: click_interval to disambiguate from double and triple presses.
|
|
|
|
#: You can run kitty with the kitty --debug-input command line option
|
|
#: to see mouse events. See the builtin actions below to get a sense
|
|
#: of what is possible.
|
|
|
|
#: If you want to unmap an action map it to ``no-op``. For example, to
|
|
#: disable opening of URLs with a plain click::
|
|
|
|
#: mouse_map left click ungrabbed no-op
|
|
|
|
#: .. note::
|
|
#: Once a selection is started, releasing the button that started it will
|
|
#: automatically end it and no release event will be dispatched.
|
|
|
|
# clear_all_mouse_actions no
|
|
|
|
#: You can have kitty remove all mouse actions seen up to this point.
|
|
#: Useful, for instance, to remove the default mouse actions.
|
|
|
|
# mouse_map left click ungrabbed mouse_click_url_or_select
|
|
# mouse_map shift+left click grabbed,ungrabbed mouse_click_url_or_select
|
|
# mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_click_url
|
|
|
|
#: Variant with ctrl+shift is present because the simple click based
|
|
#: version has an unavoidable delay of click_interval, to disambiguate
|
|
#: clicks from double clicks.
|
|
|
|
# mouse_map ctrl+shift+left press grabbed discard_event
|
|
|
|
#: Prevent this press event from being sent to the program that has
|
|
#: grabbed the mouse, as the corresponding release event is used to
|
|
#: open a URL.
|
|
|
|
# mouse_map middle release ungrabbed paste_from_selection
|
|
# mouse_map left press ungrabbed mouse_selection normal
|
|
# mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle
|
|
# mouse_map left doublepress ungrabbed mouse_selection word
|
|
# mouse_map left triplepress ungrabbed mouse_selection line
|
|
|
|
#: Select the entire line
|
|
|
|
# mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point
|
|
|
|
#: Select from the clicked point to the end of the line
|
|
|
|
# mouse_map right press ungrabbed mouse_selection extend
|
|
|
|
#: If you want only the end of the selection to be moved instead of
|
|
#: the nearest boundary, use move-end instead of extend.
|
|
|
|
# mouse_map shift+middle release ungrabbed,grabbed paste_selection
|
|
# mouse_map shift+left press ungrabbed,grabbed mouse_selection normal
|
|
# mouse_map shift+ctrl+alt+left press ungrabbed,grabbed mouse_selection rectangle
|
|
# mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word
|
|
# mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line
|
|
|
|
#: Select the entire line
|
|
|
|
# mouse_map shift+ctrl+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point
|
|
|
|
#: Select from the clicked point to the end of the line
|
|
|
|
# mouse_map shift+right press ungrabbed,grabbed mouse_selection extend
|
|
#: }}}
|
|
|
|
#: }}}
|
|
|
|
#: Performance tuning {{{
|
|
|
|
repaint_delay 10
|
|
|
|
input_delay 3
|
|
|
|
sync_to_monitor yes
|
|
|
|
#: }}}
|
|
|
|
#: Terminal bell {{{
|
|
|
|
enable_audio_bell yes
|
|
|
|
visual_bell_duration 0.0
|
|
|
|
window_alert_on_bell no
|
|
|
|
# bell_on_tab yes
|
|
|
|
# command_on_bell none
|
|
|
|
#: }}}
|
|
|
|
#: Window layout {{{
|
|
|
|
remember_window_size no
|
|
# initial_window_width 1120
|
|
# initial_window_height 700
|
|
|
|
enabled_layouts splits
|
|
|
|
window_resize_step_cells 1
|
|
window_resize_step_lines 1
|
|
|
|
window_border_width 0.1
|
|
|
|
draw_minimal_borders yes
|
|
|
|
window_margin_width 0
|
|
|
|
# single_window_margin_width -1
|
|
|
|
window_padding_width 0 8 8
|
|
|
|
# placement_strategy center
|
|
|
|
active_border_color #cba6f7
|
|
|
|
inactive_border_color #777777
|
|
|
|
# bell_border_color #ff5a00
|
|
|
|
# inactive_text_alpha 1.0
|
|
|
|
# hide_window_decorations no
|
|
|
|
# resize_debounce_time 0.1
|
|
|
|
# resize_draw_strategy static
|
|
|
|
# resize_in_steps no
|
|
|
|
confirm_os_window_close 0
|
|
|
|
#: }}}
|
|
|
|
#: Tab bar {{{
|
|
|
|
tab_bar_edge top
|
|
|
|
# tab_bar_margin_width 0.0
|
|
|
|
# tab_bar_margin_height 0.0 0.0
|
|
|
|
tab_bar_style powerline
|
|
|
|
#: The tab bar style, can be one of:
|
|
|
|
#: fade
|
|
#: Each tab's edges fade into the background color (see tab_fade)
|
|
#: slant
|
|
#: Tabs look like the tabs in a physical file
|
|
#: separator
|
|
#: Tabs are separated by a configurable separator (see tab_separator)
|
|
#: powerline
|
|
#: Tabs are shown as a continuous line with "fancy" separators (see tab_powerline_style)
|
|
#: hidden
|
|
#: The tab bar is hidden. If you use this, you might want to create a mapping
|
|
#: for the https://sw.kovidgoyal.net/kitty/actions/#select-tab action which presents you with a list
|
|
#: of tabs and allows for easy switching to a tab.
|
|
|
|
tab_bar_min_tabs 2
|
|
|
|
tab_switch_strategy previous
|
|
|
|
tab_fade 0.25 0.5 0.75 1
|
|
|
|
# tab_separator " ┇"
|
|
|
|
tab_powerline_style round
|
|
|
|
# tab_activity_symbol none
|
|
|
|
#: Some text or a unicode symbol to show on the tab if a window in the
|
|
#: tab that does not have focus has some activity. If you want to use
|
|
#: leading or trailing spaces surround the text with quotes.
|
|
|
|
tab_title_template "{sup.index} {title.replace('sankalp@sankalp:', '')}"
|
|
|
|
#: {fmt.fg.red}red{fmt.fg.default}normal{fmt.bg._00FF00}green
|
|
#: bg{fmt.bg.normal}. Similarly, for bold and italic:
|
|
#: {fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}.
|
|
|
|
active_tab_title_template none
|
|
|
|
active_tab_foreground #f38ba8
|
|
active_tab_background #333A56
|
|
active_tab_font_style normal
|
|
inactive_tab_foreground #D9E0EE
|
|
inactive_tab_background #161925
|
|
# inactive_tab_font_style italic
|
|
|
|
#: Tab bar colors and styles
|
|
|
|
tab_bar_background #161926
|
|
|
|
#: }}}
|
|
|
|
#: Color scheme {{{
|
|
|
|
background_opacity 0.1
|
|
|
|
# background_image $HOME/Pictures/3.png
|
|
|
|
#: Path to a background image. Must be in PNG format.
|
|
|
|
# background_image_layout tiled
|
|
|
|
# background_image_linear no
|
|
|
|
# dynamic_background_opacity yes
|
|
|
|
# background_tint 0.0
|
|
|
|
# dim_opacity 0.75
|
|
|
|
#: The background for text selected with the mouse.
|
|
|
|
#: The color table {{{
|
|
|
|
# background #161925
|
|
# foreground #f8f8f2
|
|
# cursor #bbbbbb
|
|
selection_background #44475a
|
|
# #: black
|
|
# color0 #000000
|
|
# color8 #4d4d4d
|
|
# #: red
|
|
# color1 #ff5555
|
|
# color9 #ff5454
|
|
# #: green
|
|
# color2 #50fa7b
|
|
# color10 #5af78e
|
|
# #: yellow
|
|
# color3 #f1fa8c
|
|
# color11 #E9AD0C
|
|
# #: blue
|
|
# color4 #bd93f9
|
|
# color12 #caa9fa
|
|
# #: magenta
|
|
# color5 #ff79c6
|
|
# color13 #ff92d0
|
|
# #: cyan
|
|
# color6 #8be9fd
|
|
# color14 #9aedfe
|
|
# #: white
|
|
# color7 #bfbfbf
|
|
# color15 #e6e6e6
|
|
|
|
#https://sw.kovidgoyal.net/kitty/conf/#opt-kitty.background_opacity
|
|
|
|
background #161926
|
|
foreground #CDD6F4
|
|
|
|
color0 #45475A
|
|
color8 #585B70
|
|
|
|
color1 #F38BA8
|
|
color9 #F38BA8
|
|
|
|
color2 #A6E3A1
|
|
color10 #A6E3A1
|
|
|
|
color3 #F9E2AF
|
|
color11 #F9E2AF
|
|
|
|
color4 #89B4FA
|
|
color12 #89B4FA
|
|
|
|
color5 #F5C2E7
|
|
color13 #F5C2E7
|
|
|
|
color6 #94E2D5
|
|
color14 #94E2D5
|
|
|
|
color7 #BAC2DE
|
|
color15 #A6ADC8
|
|
|
|
selection_foreground none
|
|
# bold_is_bright yes
|
|
|
|
# mark1_foreground black
|
|
|
|
#: Color for marks of type 1
|
|
|
|
# mark1_background #98d3cb
|
|
|
|
#: Color for marks of type 1 (light steel blue)
|
|
|
|
# mark2_foreground black
|
|
|
|
#: Color for marks of type 2
|
|
|
|
# mark2_background #f2dcd3
|
|
|
|
#: Color for marks of type 1 (beige)
|
|
|
|
# mark3_foreground black
|
|
|
|
#: Color for marks of type 3
|
|
|
|
# mark3_background #f274bc
|
|
|
|
#: Color for marks of type 3 (violet)
|
|
|
|
#: }}}
|
|
|
|
#: }}}
|
|
|
|
#: Advanced {{{
|
|
|
|
# shell .
|
|
|
|
editor vim
|
|
|
|
close_on_child_death no
|
|
|
|
#: setting.
|
|
|
|
allow_remote_control yes
|
|
|
|
# listen_on none
|
|
|
|
#: Tell kitty to listen to the specified unix/tcp socket for remote
|
|
#: control connections. Note that this will apply to all kitty
|
|
#: instances. It can be overridden by the kitty --listen-on command
|
|
#: line flag. This option accepts only UNIX sockets, such as
|
|
#: unix:${TEMP}/mykitty or (on Linux) unix:@mykitty. Environment
|
|
#: variables are expanded. If {kitty_pid} is present then it is
|
|
#: replaced by the PID of the kitty process, otherwise the PID of the
|
|
#: kitty process is appended to the value, with a hyphen. This option
|
|
#: is ignored unless you also set allow_remote_control to enable
|
|
#: remote control. See the help for kitty --listen-on for more
|
|
#: details. Changing this option by reloading the config is not
|
|
#: supported.
|
|
|
|
# env
|
|
#: env MYVAR1=a
|
|
#: env MYVAR2=${MYVAR1}/${HOME}/b
|
|
|
|
update_check_interval 0
|
|
|
|
# startup_session none
|
|
|
|
#: Path to a session file to use for all kitty instances. Can be
|
|
#: overridden by using the kitty --session command line option for
|
|
#: individual instances. See
|
|
#: https://sw.kovidgoyal.net/kitty/overview/#startup-sessions in the
|
|
#: kitty documentation for details. Note that relative paths are
|
|
#: interpreted with respect to the kitty config directory. Environment
|
|
#: variables in the path are expanded. Changing this option by
|
|
#: reloading the config is not supported.
|
|
|
|
# clipboard_control write-clipboard write-primary
|
|
|
|
# clipboard_max_size 64
|
|
|
|
allow_hyperlinks yes
|
|
|
|
term xterm-kitty
|
|
BDF8
|
|
|
|
#: The color for the border of the active window. Set this to none to
|
|
#: not draw borders around the active window.
|
|
|
|
inactive_border_color #6E738D
|
|
|
|
#: The color for the border of inactive windows.
|
|
|
|
bell_border_color #EED49F
|
|
|
|
#: The color for the border of inactive windows in which a bell has
|
|
#: occurred.
|
|
|
|
inactive_text_alpha 1.0
|
|
|
|
#: Fade the text in inactive windows by the specified amount (a number
|
|
#: between zero and one, with zero being fully faded).
|
|
|
|
hide_window_decorations yes
|
|
|
|
#: Hide the window decorations (title-bar and window borders) with
|
|
#: yes. On macOS, titlebar-only can be used to only hide the titlebar.
|
|
#: Whether this works and exactly what effect it has depends on the
|
|
#: window manager/operating system. Note that the effects of changing
|
|
#: this option when reloading config are undefined.
|
|
|
|
window_logo_path none
|
|
|
|
#: Path to a logo image. Must be in PNG format. Relative paths are
|
|
#: interpreted relative to the kitty config directory. The logo is
|
|
#: displayed in a corner of every kitty window. The position is
|
|
#: controlled by window_logo_position. Individual windows can be
|
|
#: configured to have different logos either using the launch action
|
|
#: or the remote control <https://sw.kovidgoyal.net/kitty/remote-
|
|
#: control/> facility.
|
|
|
|
window_logo_position bottom-right
|
|
|
|
#: Where to position the window logo in the window. The value can be
|
|
#: one of: top-left, top, top-right, left, center, right, bottom-left,
|
|
#: bottom, bottom-right.
|
|
|
|
window_logo_alpha 0.5
|
|
|
|
#: The amount the logo should be faded into the background. With zero
|
|
#: being fully faded and one being fully opaque.
|
|
|
|
resize_debounce_time 0.1
|
|
|
|
#: The time to wait before redrawing the screen when a resize event is
|
|
#: received (in seconds). On platforms such as macOS, where the
|
|
#: operating system sends events corresponding to the start and end of
|
|
#: a resize, this number is ignored.
|
|
|
|
resize_draw_strategy static
|
|
|
|
#: Choose how kitty draws a window while a resize is in progress. A
|
|
#: value of static means draw the current window contents, mostly
|
|
#: unchanged. A value of scale means draw the current window contents
|
|
#: scaled. A value of blank means draw a blank window. A value of size
|
|
#: means show the window size in cells.
|
|
|
|
resize_in_steps no
|
|
|
|
#: Resize the OS window in steps as large as the cells, instead of
|
|
#: with the usual pixel accuracy. Combined with initial_window_width
|
|
#: and initial_window_height in number of cells, this option can be
|
|
#: used to keep the margins as small as possible when resizing the OS
|
|
#: window. Note that this does not currently work on Wayland.
|
|
|
|
visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
|
|
|
|
#: The list of characters for visual window selection. For example,
|
|
#: for selecting a window to focus on with focus_visible_window. The
|
|
#: value should be a series of unique numbers or alphabets, case
|
|
#: insensitive, from the set [0-9A-Z]. Specify your preference as a
|
|
#: string of characters.
|
|
|
|
confirm_os_window_close 0
|
|
|
|
#: Ask for confirmation when closing an OS window or a tab with at
|
|
#: least this number of kitty windows in it by window manager (e.g.
|
|
#: clicking the window close button or pressing the operating system
|
|
#: shortcut to close windows) or by the close_tab action. A value of
|
|
#: zero disables confirmation. This confirmation also applies to
|
|
#: requests to quit the entire application (all OS windows, via the
|
|
#: quit action). Negative values are converted to positive ones,
|
|
#: however, with shell_integration enabled, using negative values
|
|
#: means windows sitting at a shell prompt are not counted, only
|
|
#: windows where some command is currently running. Note that if you
|
|
#: want confirmation when closing individual windows, you can map the
|
|
#: close_window_with_confirmation action.
|
|
|
|
#: }}}
|
|
|
|
#: Tab bar {{{
|
|
|
|
tab_bar_edge bottom
|
|
|
|
#: The edge to show the tab bar on, top or bottom.
|
|
|
|
tab_bar_margin_width 0.0
|
|
|
|
#: The margin to the left and right of the tab bar (in pts).
|
|
|
|
tab_bar_margin_height 0.0 0.0
|
|
|
|
#: The margin above and below the tab bar (in pts). The first number
|
|
#: is the margin between the edge of the OS Window and the tab bar.
|
|
#: The second number is the margin between the tab bar and the
|
|
#: contents of the current tab.
|
|
|
|
tab_bar_style powerline
|
|
|
|
#: The tab bar style, can be one of:
|
|
|
|
#: fade
|
|
#: Each tab's edges fade into the background color. (See also tab_fade)
|
|
#: slant
|
|
#: Tabs look like the tabs in a physical file.
|
|
#: separator
|
|
#: Tabs are separated by a configurable separator. (See also
|
|
#: tab_separator)
|
|
#: powerline
|
|
#: Tabs are shown as a continuous line with "fancy" separators.
|
|
#: (See also tab_powerline_style)
|
|
#: custom
|
|
#: A user-supplied Python function called draw_tab is loaded from the file
|
|
#: tab_bar.py in the kitty config directory. For examples of how to
|
|
#: write such a function, see the functions named draw_tab_with_* in
|
|
#: kitty's source code: kitty/tab_bar.py. See also
|
|
#: this discussion https://github.com/kovidgoyal/kitty/discussions/4447
|
|
#: for examples from kitty users.
|
|
#: hidden
|
|
#: The tab bar is hidden. If you use this, you might want to create a mapping
|
|
#: for the select_tab action which presents you with a list of tabs and
|
|
#: allows for easy switching to a tab.
|
|
|
|
tab_bar_align left
|
|
|
|
#: The horizontal alignment of the tab bar, can be one of: left,
|
|
#: center, right.
|
|
|
|
tab_bar_min_tabs 2
|
|
|
|
#: The minimum number of tabs that must exist before the tab bar is
|
|
#: shown.
|
|
|
|
tab_switch_strategy previous
|
|
|
|
#: The algorithm to use when switching to a tab when the current tab
|
|
#: is closed. The default of previous will switch to the last used
|
|
#: tab. A value of left will switch to the tab to the left of the
|
|
#: closed tab. A value of right will switch to the tab to the right of
|
|
#: the closed tab. A value of last will switch to the right-most tab.
|
|
|
|
tab_fade 0.25 0.5 0.75 1
|
|
|
|
#: Control how each tab fades into the background when using fade for
|
|
#: the tab_bar_style. Each number is an alpha (between zero and one)
|
|
#: that controls how much the corresponding cell fades into the
|
|
#: background, with zero being no fade and one being full fade. You
|
|
#: can change the number of cells used by adding/removing entries to
|
|
#: this list.
|
|
|
|
tab_separator " ┇"
|
|
|
|
#: The separator between tabs in the tab bar when using separator as
|
|
#: the tab_bar_style.
|
|
|
|
tab_powerline_style slanted
|
|
|
|
#: The powerline separator style between tabs in the tab bar when
|
|
#: using powerline as the tab_bar_style, can be one of: angled,
|
|
#: slanted, round.
|
|
|
|
tab_activity_symbol none
|
|
|
|
#: Some text or a Unicode symbol to show on the tab if a window in the
|
|
#: tab that does not have focus has some activity. If you want to use
|
|
#: leading or trailing spaces, surround the text with quotes. See
|
|
#: tab_title_template for how this is rendered.
|
|
|
|
tab_title_template "{f'{title[:30]}…' if title.rindex(title[-1]) + 1 > 30 else (title.center(6) if (title.rindex(title[-1]) + 1) % 2 == 0 else title.center(5))}"
|
|
|
|
#: A template to render the tab title. The default just renders the
|
|
#: title with optional symbols for bell and activity. If you wish to
|
|
#: include the tab-index as well, use something like: {index}:{title}.
|
|
#: Useful if you have shortcuts mapped for goto_tab N. If you prefer
|
|
#: to see the index as a superscript, use {sup.index}. In addition you
|
|
#: can use {layout_name} for the current layout name, {num_windows}
|
|
#: for the number of windows in the tab and {num_window_groups} for
|
|
#: the number of window groups (not counting overlay windows) in the
|
|
#: tab. Note that formatting is done by Python's string formatting
|
|
#: machinery, so you can use, for instance, {layout_name[:2].upper()}
|
|
#: to show only the first two letters of the layout name, upper-cased.
|
|
#: If you want to style the text, you can use styling directives, for
|
|
#: example:
|
|
#: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`.
|
|
#: Similarly, for bold and italic:
|
|
#: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`.
|
|
#: Note that for backward compatibility, if {bell_symbol} or
|
|
#: {activity_symbol} are not present in the template, they are
|
|
#: prepended to it.
|
|
|
|
active_tab_title_template none
|
|
|
|
#: Template to use for active tabs. If not specified falls back to
|
|
#: tab_title_template.
|
|
active_tab_foreground #1e2030
|
|
active_tab_background #b7bdf8
|
|
inactive_tab_foreground #CAD3F5
|
|
inactive_tab_background #1E2030
|
|
tab_bar_background #1e2030
|
|
active_tab_font_style bold-italic
|
|
inactive_tab_font_style normal
|
|
|
|
#: Tab bar colors and styles.
|
|
|
|
#: Background color for the tab bar. Defaults to using the terminal
|
|
#: background color.
|
|
|
|
tab_bar_margin_color #1e2030
|
|
|
|
#: Color for the tab bar margin area. Defaults to using the terminal
|
|
#: background color.
|
|
|
|
#: }}}
|
|
|
|
#: Color scheme {{{
|
|
|
|
foreground #CAD3F5
|
|
background #24273A
|
|
|
|
#: The foreground and background colors.
|
|
|
|
background_opacity 0.7
|
|
|
|
#: The opacity of the background. A number between zero and one, where
|
|
#: one is opaque and zero is fully transparent. This will only work if
|
|
#: supported by the OS (for instance, when using a compositor under
|
|
#: X11). Note that it only sets the background color's opacity in
|
|
#: cells that have the same background color as the default terminal
|
|
#: background, so that things like the status bar in vim, powerline
|
|
#: prompts, etc. still look good. But it means that if you use a color
|
|
#: theme with a background color in your editor, it will not be
|
|
#: rendered as transparent. Instead you should change the default
|
|
#: background color in your kitty config and not use a background
|
|
#: color in the editor color scheme. Or use the escape codes to set
|
|
#: the terminals default colors in a shell script to launch your
|
|
#: editor. Be aware that using a value less than 1.0 is a (possibly
|
|
#: significant) performance hit. If you want to dynamically change
|
|
#: transparency of windows, set dynamic_background_opacity to yes
|
|
#: (this is off by default as it has a performance cost). Changing
|
|
#: this option when reloading the config will only work if
|
|
#: dynamic_background_opacity was enabled in the original config.
|
|
|
|
background_image none
|
|
|
|
#: Path to a background image. Must be in PNG format.
|
|
|
|
background_image_layout tiled
|
|
|
|
#: Whether to tile, scale or clamp the background image. The value can
|
|
#: be one of tiled, mirror-tiled, scaled, clamped.
|
|
|
|
background_image_linear no
|
|
|
|
#: When background image is scaled, whether linear interpolation
|
|
#: should be used.
|
|
|
|
dynamic_background_opacity no
|
|
|
|
#: Allow changing of the background_opacity dynamically, using either
|
|
#: keyboard shortcuts (increase_background_opacity and
|
|
#: decrease_background_opacity) or the remote control facility.
|
|
#: Changing this option by reloading the config is not supported.
|
|
|
|
background_tint 0.0
|
|
|
|
#: How much to tint the background image by the background color. The
|
|
#: tint is applied only under the text area, not margin/borders. This
|
|
#: option makes it easier to read the text. Tinting is done using the
|
|
#: current background color for each window. This option applies only
|
|
#: if background_opacity is set and transparent windows are supported
|
|
#: or background_image is set.
|
|
|
|
dim_opacity 0.75
|
|
|
|
#: How much to dim text that has the DIM/FAINT attribute set. One
|
|
#: means no dimming and zero means fully dimmed (i.e. invisible).
|
|
|
|
selection_foreground #24273A
|
|
selection_background #F4DBD6
|
|
|
|
#: The foreground and background colors for text selected with the
|
|
#: mouse. Setting both of these to none will cause a "reverse video"
|
|
#: effect for selections, where the selection will be the cell text
|
|
#: color and the text will become the cell background color. Setting
|
|
#: only selection_foreground to none will cause the foreground color
|
|
#: to be used unchanged. Note that these colors can be overridden by
|
|
#: the program running in the terminal.
|
|
|
|
#: The color table {{{
|
|
|
|
#: The 256 terminal colors. There are 8 basic colors, each color has a
|
|
#: dull and bright version, for the first 16 colors. You can set the
|
|
#: remaining 240 colors as color16 to color255.
|
|
|
|
# black
|
|
color0 #494D64
|
|
color8 #5B6078
|
|
|
|
# red
|
|
color1 #ED8796
|
|
color9 #ED8796
|
|
|
|
# green
|
|
color2 #A6DA95
|
|
color10 #A6DA95
|
|
|
|
# yellow
|
|
color3 #EED49F
|
|
color11 #EED49F
|
|
|
|
# blue
|
|
color4 #8AADF4
|
|
color12 #8AADF4
|
|
|
|
# magenta
|
|
color5 #F5BDE6
|
|
color13 #F5BDE6
|
|
|
|
# cyan
|
|
color6 #8BD5CA
|
|
color14 #8BD5CA
|
|
|
|
# white
|
|
color7 #B8C0E0
|
|
color15 #A5ADCB
|
|
|
|
mark1_foreground #24273A
|
|
mark1_background #B7BDF8
|
|
mark2_foreground #24273A
|
|
mark2_background #C6A0F6
|
|
mark3_foreground #24273A
|
|
mark3_background #7DC4E4
|
|
|
|
#: Color for marks of type 3 (violet)
|
|
|
|
#: }}}
|
|
|
|
#: }}}
|
|
|
|
#: Advanced {{{
|
|
|
|
shell zsh
|
|
|
|
#: The shell program to execute. The default value of . means to use
|
|
#: whatever shell is set as the default shell for the current user.
|
|
#: Note that on macOS if you change this, you might need to add
|
|
#: --login and --interactive to ensure that the shell starts in
|
|
#: interactive mode and reads its startup rc files.
|
|
|
|
editor nvim
|
|
|
|
#: The terminal based text editor (such as vim or nano) to use when
|
|
#: editing the kitty config file or similar tasks.
|
|
|
|
#: The default value of . means to use the environment variables
|
|
#: VISUAL and EDITOR in that order. If these variables aren't set,
|
|
#: kitty will run your shell ($SHELL -l -i -c env) to see if your
|
|
#: shell startup rc files set VISUAL or EDITOR. If that doesn't work,
|
|
#: kitty will cycle through various known editors (vim, emacs, etc.)
|
|
#: and take the first one that exists on your system.
|
|
|
|
close_on_child_death no
|
|
|
|
#: Close the window when the child process (shell) exits. With the
|
|
#: default value no, the terminal will remain open when the child
|
|
#: exits as long as there are still processes outputting to the
|
|
#: terminal (for example disowned or backgrounded processes). When
|
|
#: enabled with yes, the window will close as soon as the child
|
|
#: process exits. Note that setting it to yes means that any
|
|
#: background processes still using the terminal can fail silently
|
|
#: because their stdout/stderr/stdin no longer work.
|
|
|
|
allow_remote_control yes
|
|
|
|
#: Allow other programs to control kitty. If you turn this on, other
|
|
#: programs can control all aspects of kitty, including sending text
|
|
#: to kitty windows, opening new windows, closing windows, reading the
|
|
#: content of windows, etc. Note that this even works over SSH
|
|
#: connections. You can choose to either allow any program running
|
|
#: within kitty to control it with yes, or only allow programs that
|
|
#: connect to the socket (specified with the listen_on config option
|
|
#: or kitty --listen-on command line option) with the value socket-
|
|
#: only. The latter is useful if you want to prevent programs running
|
|
#: on a remote computer over SSH from controlling kitty. Reloading the
|
|
#: config will not affect this option.
|
|
|
|
listen_on unix:@mykitty
|
|
|
|
#: Listen to the specified UNIX socket for remote control connections.
|
|
#: Note that this will apply to all kitty instances. It can be
|
|
#: overridden by the kitty --listen-on command line option, which
|
|
#: supports listening on TCP socket. This option accepts only UNIX
|
|
#: sockets, such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux).
|
|
#: Environment variables are expanded and relative paths are resolved
|
|
#: with respect to the temporary directory. If {kitty_pid} is present,
|
|
#: then it is replaced by the PID of the kitty process, otherwise the
|
|
#: PID of the kitty process is appended to the value, with a hyphen.
|
|
#: This option is ignored unless you also set allow_remote_control to
|
|
#: enable remote control. See the help for kitty --listen-on for more
|
|
#: details. Changing this option by reloading the config is not
|
|
#: supported.
|
|
|
|
# env
|
|
|
|
#: Specify the environment variables to be set in all child processes.
|
|
#: Using the name with an equal sign (e.g. env VAR=) will set it to
|
|
#: the empty string. Specifying only the name (e.g. env VAR) will
|
|
#: remove the variable from the child process' environment. Note that
|
|
#: environment variables are expanded recursively, for example::
|
|
|
|
#: env VAR1=a
|
|
#: env VAR2=${HOME}/${VAR1}/b
|
|
|
|
#: The value of VAR2 will be <path to home directory>/a/b.
|
|
|
|
# watcher
|
|
|
|
#: Path to python file which will be loaded for watchers
|
|
#: <https://sw.kovidgoyal.net/kitty/launch/#watchers>. Can be
|
|
#: specified more than once to load multiple watchers. The watchers
|
|
#: will be added to every kitty window. Relative paths are resolved
|
|
#: relative to the kitty config directory. Note that reloading the
|
|
#: config will only affect windows created after the reload.
|
|
|
|
# exe_search_path
|
|
|
|
#: Control where kitty finds the programs to run. The default search
|
|
#: order is: First search the system wide PATH, then ~/.local/bin and
|
|
#: ~/bin. If still not found, the PATH defined in the login shell
|
|
#: after sourcing all its startup files is tried. Finally, if present,
|
|
#: the PATH specified by the env option is tried.
|
|
|
|
#: This option allows you to prepend, append, or remove paths from
|
|
#: this search order. It can be specified multiple times for multiple
|
|
#: paths. A simple path will be prepended to the search order. A path
|
|
#: that starts with the + sign will be append to the search order,
|
|
#: after ~/bin above. A path that starts with the - sign will be
|
|
#: removed from the entire search order. For example::
|
|
|
|
#: exe_search_path /some/prepended/path
|
|
#: exe_search_path +/some/appended/path
|
|
#: exe_search_path -/some/excluded/path
|
|
|
|
update_check_interval 24
|
|
|
|
#: The interval to periodically check if an update to kitty is
|
|
#: available (in hours). If an update is found, a system notification
|
|
#: is displayed informing you of the available update. The default is
|
|
#: to check every 24 hours, set to zero to disable. Update checking is
|
|
#: only done by the official binary builds. Distro packages or source
|
|
#: builds do not do update checking. Changing this option by reloading
|
|
#: the config is not supported.
|
|
|
|
startup_session none
|
|
|
|
#: Path to a session file to use for all kitty instances. Can be
|
|
#: overridden by using the kitty --session command line option for
|
|
#: individual instances. See sessions
|
|
#: <https://sw.kovidgoyal.net/kitty/overview/#startup-sessions> in the
|
|
#: kitty documentation for details. Note that relative paths are
|
|
#: interpreted with respect to the kitty config directory. Environment
|
|
#: variables in the path are expanded. Changing this option by
|
|
#: reloading the config is not supported.
|
|
|
|
clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask
|
|
|
|
#: Allow programs running in kitty to read and write from the
|
|
#: clipboard. You can control exactly which actions are allowed. The
|
|
#: possible actions are: write-clipboard, read-clipboard, write-
|
|
#: primary, read-primary, read-clipboard-ask, read-primary-ask. The
|
|
#: default is to allow writing to the clipboard and primary selection
|
|
#: and to ask for permission when a program tries to read from the
|
|
#: clipboard. Note that disabling the read confirmation is a security
|
|
#: risk as it means that any program, even the ones running on a
|
|
#: remote server via SSH can read your clipboard. See also
|
|
#: clipboard_max_size.
|
|
|
|
clipboard_max_size 64
|
|
|
|
#: The maximum size (in MB) of data from programs running in kitty
|
|
#: that will be stored for writing to the system clipboard. A value of
|
|
#: zero means no size limit is applied. See also clipboard_control.
|
|
|
|
# file_transfer_confirmation_bypass
|
|
|
|
#: The password that can be supplied to the file transfer kitten
|
|
#: <https://sw.kovidgoyal.net/kitty/kittens/transfer/> to skip the
|
|
#: transfer confirmation prompt. This should only be used when
|
|
#: initiating transfers from trusted computers, over trusted networks
|
|
#: or encrypted transports, as it allows any programs running on the
|
|
#: remote machine to read/write to the local filesystem, without
|
|
#: permission.
|
|
|
|
allow_hyperlinks yes
|
|
|
|
#: Process hyperlink escape sequences (OSC 8). If disabled OSC 8
|
|
#: escape sequences are ignored. Otherwise they become clickable
|
|
#: links, that you can click with the mouse or by using the hints
|
|
#: kitten <https://sw.kovidgoyal.net/kitty/kittens/hints/>. The
|
|
#: special value of ask means that kitty will ask before opening the
|
|
#: link when clicked.
|
|
|
|
shell_integration enabled
|
|
|
|
#: Enable shell integration on supported shells. This enables features
|
|
#: such as jumping to previous prompts, browsing the output of the
|
|
#: previous command in a pager, etc. on supported shells. Set to
|
|
#: disabled to turn off shell integration, completely. It is also
|
|
#: possible to disable individual features, set to a space separated
|
|
#: list of these values: no-rc, no-cursor, no-title, no-cwd, no-
|
|
#: prompt-mark, no-complete. See Shell integration
|
|
#: <https://sw.kovidgoyal.net/kitty/shell-integration/> for details.
|
|
|
|
allow_cloning ask
|
|
|
|
#: Control whether programs running in the terminal can request new
|
|
#: windows to be created. The canonical example is clone-in-kitty
|
|
#: <https://sw.kovidgoyal.net/kitty/shell-integration/#clone-shell>.
|
|
#: By default, kitty will ask for permission for each clone request.
|
|
#: Allowing cloning unconditionally gives programs running in the
|
|
#: terminal (including over SSH) permission to execute arbitrary code,
|
|
#: as the user who is running the terminal, on the computer that the
|
|
#: terminal is running on.
|
|
|
|
clone_source_strategies venv,conda,env_var,path
|
|
|
|
#: Control what shell code is sourced when running clone-in-kitty in
|
|
#: the newly cloned window. The supported strategies are:
|
|
|
|
#: venv
|
|
#: Source the file $VIRTUAL_ENV/bin/activate. This is used by the
|
|
#: Python stdlib venv module and allows cloning venvs automatically.
|
|
#: conda
|
|
#: Run conda activate $CONDA_DEFAULT_ENV. This supports the virtual
|
|
#: environments created by conda.
|
|
#: env_var
|
|
#: Execute the contents of the environment variable
|
|
#: KITTY_CLONE_SOURCE_CODE with eval.
|
|
#: path
|
|
#: Source the file pointed to by the environment variable
|
|
#: KITTY_CLONE_SOURCE_PATH.
|
|
|
|
#: This option must be a comma separated list of the above values.
|
|
#: This only source the first valid one in the above order.
|
|
|
|
term xterm-kitty
|
|
|
|
#: The value of the TERM environment variable to set. Changing this
|
|
#: can break many terminal programs, only change it if you know what
|
|
#: you are doing, not because you read some advice on "Stack Overflow"
|
|
#: to change it. The TERM variable is used by various programs to get
|
|
#: information about the capabilities and behavior of the terminal. If
|
|
#: you change it, depending on what programs you run, and how
|
|
#: different the terminal you are changing it to is, various things
|
|
#: from key-presses, to colors, to various advanced features may not
|
|
#: work. Changing this option by reloading the config will only affect
|
|
#: newly created windows.
|
|
|
|
#: }}}
|
|
|
|
#: OS specific tweaks {{{
|
|
|
|
wayland_titlebar_color system
|
|
|
|
#: The color of the kitty window's titlebar on Wayland systems with
|
|
#: client side window decorations such as GNOME. A value of system
|
|
#: means to use the default system color, a value of background means
|
|
#: to use the background color of the currently active window and
|
|
#: finally you can use an arbitrary color, such as #12af59 or red.
|
|
|
|
macos_titlebar_color system
|
|
|
|
#: The color of the kitty window's titlebar on macOS. A value of
|
|
#: system means to use the default system color, light or dark can
|
|
#: also be used to set it explicitly. A value of background means to
|
|
#: use the background color of the currently active window and finally
|
|
#: you can use an arbitrary color, such as #12af59 or red. WARNING:
|
|
#: This option works by using a hack when arbitrary color (or
|
|
#: background) is configured, as there is no proper Cocoa API for it.
|
|
#: It sets the background color of the entire window and makes the
|
|
#: titlebar transparent. As such it is incompatible with
|
|
#: background_opacity. If you want to use both, you are probably
|
|
#: better off just hiding the titlebar with hide_window_decorations.
|
|
|
|
macos_option_as_alt no
|
|
|
|
#: Use the Option key as an Alt key on macOS. With this set to no,
|
|
#: kitty will use the macOS native Option+Key to enter Unicode
|
|
#: character behavior. This will break any Alt+Key keyboard shortcuts
|
|
#: in your terminal programs, but you can use the macOS Unicode input
|
|
#: technique. You can use the values: left, right or both to use only
|
|
#: the left, right or both Option keys as Alt, instead. Note that
|
|
#: kitty itself always treats Option the same as Alt. This means you
|
|
#: cannot use this option to configure different kitty shortcuts for
|
|
#: Option+Key vs. Alt+Key. Also, any kitty shortcuts using
|
|
#: Option/Alt+Key will take priority, so that any such key presses
|
|
#: will not be passed to terminal programs running inside kitty.
|
|
#: Changing this option by reloading the config is not supported.
|
|
|
|
macos_hide_from_tasks no
|
|
|
|
#: Hide the kitty window from running tasks on macOS (⌘+Tab and the
|
|
#: Dock). Changing this option by reloading the config is not
|
|
#: supported.
|
|
|
|
macos_quit_when_last_window_closed no
|
|
|
|
#: Have kitty quit when all the top-level windows are closed on macOS.
|
|
#: By default, kitty will stay running, even with no open windows, as
|
|
#: is the expected behavior on macOS.
|
|
|
|
macos_window_resizable yes
|
|
|
|
#: Disable this if you want kitty top-level OS windows to not be
|
|
#: resizable on macOS. Changing this option by reloading the config
|
|
#: will only affect newly created OS windows.
|
|
|
|
macos_thicken_font 0
|
|
|
|
#: Draw an extra border around the font with the given width, to
|
|
#: increase legibility at small font sizes on macOS. For example, a
|
|
#: value of 0.75 will result in rendering that looks similar to sub-
|
|
#: pixel antialiasing at common font sizes.
|
|
|
|
macos_traditional_fullscreen no
|
|
|
|
#: Use the macOS traditional full-screen transition, that is faster,
|
|
#: but less pretty.
|
|
|
|
macos_show_window_title_in all
|
|
|
|
#: Control where the window title is displayed on macOS. A value of
|
|
#: window will show the title of the currently active window at the
|
|
#: top of the macOS window. A value of menubar will show the title of
|
|
#: the currently active window in the macOS global menu bar, making
|
|
#: use of otherwise wasted space. A value of all will show the title
|
|
#: in both places, and none hides the title. See
|
|
#: macos_menubar_title_max_length for how to control the length of the
|
|
#: title in the menu bar.
|
|
|
|
macos_menubar_title_max_length 0
|
|
|
|
#: The maximum number of characters from the window title to show in
|
|
#: the macOS global menu bar. Values less than one means that there is
|
|
#: no maximum limit.
|
|
|
|
macos_custom_beam_cursor no
|
|
|
|
#: Use a custom mouse cursor for macOS that is easier to see on both
|
|
#: light and dark backgrounds. Nowadays, the default macOS cursor
|
|
#: already comes with a white border. WARNING: this might make your
|
|
#: mouse cursor invisible on dual GPU machines. Changing this option
|
|
#: by reloading the config is not supported.
|
|
|
|
macos_colorspace srgb
|
|
|
|
#: The colorspace in which to interpret terminal colors. The default
|
|
#: of srgb will cause colors to match those seen in web browsers. The
|
|
#: value of default will use whatever the native colorspace of the
|
|
#: display is. The value of displayp3 will use Apple's special
|
|
#: snowflake display P3 color space, which will result in over
|
|
#: saturated (brighter) colors with some color shift. Reloading
|
|
#: configuration will change this value only for newly created OS
|
|
#: windows.
|
|
|
|
linux_display_server auto
|
|
|
|
#: Choose between Wayland and X11 backends. By default, an appropriate
|
|
#: backend based on the system state is chosen automatically. Set it
|
|
#: to x11 or wayland to force the choice. Changing this option by
|
|
#: reloading the config is not supported.
|
|
mouse_map ctrl+shift+left press grabbed discard_event
|
|
|
|
#:: Prevent this press event from being sent to the program that has
|
|
#:: grabbed the mouse, as the corresponding release event is used to
|
|
#:: open a URL.
|
|
|
|
#: Paste from the primary selection
|
|
|
|
mouse_map middle release ungrabbed paste_from_selection
|
|
|
|
#: Start selecting text
|
|
|
|
mouse_map left press ungrabbed mouse_selection normal
|
|
|
|
#: Start selecting text in a rectangle
|
|
|
|
mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle
|
|
|
|
#: Select a word
|
|
|
|
mouse_map left doublepress ungrabbed mouse_selection word
|
|
|
|
#: Select a line
|
|
|
|
mouse_map left triplepress ungrabbed mouse_selection line
|
|
|
|
#: Select line from point
|
|
|
|
mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point
|
|
|
|
#:: Select from the clicked point to the end of the line.
|
|
|
|
#: Extend the current selection
|
|
|
|
mouse_map right press ungrabbed mouse_selection extend
|
|
|
|
#:: If you want only the end of the selection to be moved instead of
|
|
#:: the nearest boundary, use move-end instead of extend.
|
|
|
|
#: Paste from the primary selection even when grabbed
|
|
|
|
mouse_map shift+middle release ungrabbed,grabbed paste_selection
|
|
mouse_map shift+middle press grabbed discard_event
|
|
|
|
#: Start selecting text even when grabbed
|
|
|
|
mouse_map shift+left press ungrabbed,grabbed mouse_selection normal
|
|
|
|
#: Start selecting text in a rectangle even when grabbed
|
|
|
|
mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle
|
|
|
|
#: Select a word even when grabbed
|
|
|
|
mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word
|
|
|
|
#: Select a line even when grabbed
|
|
|
|
mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line
|
|
|
|
#: Select line from point even when grabbed
|
|
|
|
mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point
|
|
|
|
#:: Select from the clicked point to the end of the line even when
|
|
#:: grabbed.
|
|
|
|
#: Extend the current selection even when grabbed
|
|
|
|
mouse_map shift+right press ungrabbed,grabbed mouse_selection extend
|
|
|
|
#: Show clicked command output in pager
|
|
|
|
mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output
|
|
|
|
#:: Requires shell integration
|
|
#:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work.
|
|
|
|
#: }}}
|
|
|
|
#: }}}
|
|
|
|
#: Performance tuning {{{
|
|
|
|
repaint_delay 10
|
|
|
|
#: Delay between screen updates (in milliseconds). Decreasing it,
|
|
#: increases frames-per-second (FPS) at the cost of more CPU usage.
|
|
#: The default value yields ~100 FPS which is more than sufficient for
|
|
#: most uses. Note that to actually achieve 100 FPS, you have to
|
|
#: either set sync_to_monitor to no or use a monitor with a high
|
|
#: refresh rate. Also, to minimize latency when there is pending input
|
|
#: to be processed, this option is ignored.
|
|
|
|
input_delay 3
|
|
|
|
#: Delay before input from the program running in the terminal is
|
|
#: processed (in milliseconds). Note that decreasing it will increase
|
|
#: responsiveness, but also increase CPU usage and might cause flicker
|
|
#: in full screen programs that redraw the entire screen on each loop,
|
|
#: because kitty is so fast that partial screen updates will be drawn.
|
|
|
|
sync_to_monitor yes
|
|
|
|
#: Sync screen updates to the refresh rate of the monitor. This
|
|
#: prevents screen tearing
|
|
#: <https://en.wikipedia.org/wiki/Screen_tearing> when scrolling.
|
|
#: However, it limits the rendering speed to the refresh rate of your
|
|
#: monitor. With a very high speed mouse/high keyboard repeat rate,
|
|
#: you may notice some slight input latency. If so, set this to no.
|
|
|
|
#: }}}
|
|
|
|
#: Terminal bell {{{
|
|
|
|
enable_audio_bell yes
|
|
|
|
#: The audio bell. Useful to disable it in environments that require
|
|
#: silence.
|
|
|
|
visual_bell_duration 0.0
|
|
|
|
#: The visual bell duration (in seconds). Flash the screen when a bell
|
|
#: occurs for the specified number of seconds. Set to zero to disable.
|
|
|
|
visual_bell_color none
|
|
|
|
#: The color used by visual bell. Set to none will fall back to
|
|
#: selection background color. If you feel that the visual bell is too
|
|
#: bright, you can set it to a darker color.
|
|
|
|
window_alert_on_bell yes
|
|
|
|
#: Request window attention on bell. Makes the dock icon bounce on
|
|
#: macOS or the taskbar flash on linux.
|
|
|
|
bell_on_tab "🔔 "
|
|
|
|
#: Some text or a Unicode symbol to show on the tab if a window in the
|
|
#: tab that does not have focus has a bell. If you want to use leading
|
|
#: or trailing spaces, surround the text with quotes. See
|
|
#: tab_title_template for how this is rendered.
|
|
|
|
#: For backwards compatibility, values of yes, y and true are
|
|
#: converted to the default bell symbol and no, n, false and none are
|
|
#: converted to the empty string.
|
|
|
|
command_on_bell none
|
|
|
|
#: Program to run when a bell occurs. The environment variable
|
|
#: KITTY_CHILD_CMDLINE can be used to get the program running in the
|
|
#: window in which the bell occurred.
|
|
|
|
bell_path none
|
|
|
|
#: Path to a sound file to play as the bell sound. If set to none, the
|
|
#: system default bell sound is used. Must be in a format supported by
|
|
#: the operating systems sound API, such as WAV or OGA on Linux
|
|
#: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound)
|
|
|
|
#: }}}
|
|
|
|
#: Window layout {{{
|
|
|
|
remember_window_size yes
|
|
initial_window_width 640
|
|
initial_window_height 400
|
|
|
|
#: If enabled, the window size will be remembered so that new
|
|
#: instances of kitty will have the same size as the previous
|
|
#: instance. If disabled, the window will initially have size
|
|
#: configured by initial_window_width/height, in pixels. You can use a
|
|
#: suffix of "c" on the width/height values to have them interpreted
|
|
#: as number of cells instead of pixels.
|
|
|
|
enabled_layouts *
|
|
|
|
#: The enabled window layouts. A comma separated list of layout names.
|
|
#: The special value all means all layouts. The first listed layout
|
|
#: will be used as the startup layout. Default configuration is all
|
|
#: layouts in alphabetical order. For a list of available layouts, see
|
|
#: the layouts <https://sw.kovidgoyal.net/kitty/overview/#layouts>.
|
|
|
|
window_resize_step_cells 2
|
|
window_resize_step_lines 2
|
|
|
|
#: The step size (in units of cell width/cell height) to use when
|
|
#: resizing kitty windows in a layout with the shortcut
|
|
#: start_resizing_window. The cells value is used for horizontal
|
|
#: resizing, and the lines value is used for vertical resizing.
|
|
|
|
window_border_width 1pt
|
|
|
|
#: The width of window borders. Can be either in pixels (px) or pts
|
|
#: (pt). Values in pts will be rounded to the nearest number of pixels
|
|
#: based on screen resolution. If not specified, the unit is assumed
|
|
#: to be pts. Note that borders are displayed only when more than one
|
|
#: window is visible. They are meant to separate multiple windows.
|
|
|
|
draw_minimal_borders yes
|
|
|
|
#: Draw only the minimum borders needed. This means that only the
|
|
#: borders that separate the inactive window from a neighbor are
|
|
#: drawn. Note that setting a non-zero window_margin_width overrides
|
|
#: this and causes all borders to be drawn.
|
|
|
|
window_margin_width 0
|
|
|
|
#: The window margin (in pts) (blank area outside the border). A
|
|
#: single value sets all four sides. Two values set the vertical and
|
|
#: horizontal sides. Three values set top, horizontal and bottom. Four
|
|
#: values set top, right, bottom and left.
|
|
|
|
single_window_margin_width -1
|
|
|
|
#: The window margin to use when only a single window is visible (in
|
|
#: pts). Negative values will cause the value of window_margin_width
|
|
#: to be used instead. A single value sets all four sides. Two values
|
|
#: set the vertical and horizontal sides. Three values set top,
|
|
#: horizontal and bottom. Four values set top, right, bottom and left.
|
|
|
|
window_padding_width 10
|
|
|
|
#: The window padding (in pts) (blank area between the text and the
|
|
#: window border). A single value sets all four sides. Two values set
|
|
#: the vertical and horizontal sides. Three values set top, horizontal
|
|
#: and bottom. Four values set top, right, bottom and left.
|
|
|
|
placement_strategy center
|
|
|
|
#: When the window size is not an exact multiple of the cell size, the
|
|
#: cell area of the terminal window will have some extra padding on
|
|
#: the sides. You can control how that padding is distributed with
|
|
#: this option. Using a value of center means the cell area will be
|
|
#: placed centrally. A value of top-left means the padding will be
|
|
#: only at the bottom and right edges.
|
|
|
|
active_border_color #B7BDF8
|
|
|
|
#: The color for the border of the active window. Set this to none to
|
|
#: not draw borders around the active window.
|
|
|
|
inactive_border_color #6E738D
|
|
|
|
#: The color for the border of inactive windows.
|
|
|
|
bell_border_color #EED49F
|
|
|
|
#: The color for the border of inactive windows in which a bell has
|
|
#: occurred.
|
|
|
|
inactive_text_alpha 1.0
|
|
|
|
#: Fade the text in inactive windows by the specified amount (a number
|
|
#: between zero and one, with zero being fully faded).
|
|
|
|
hide_window_decorations yes
|
|
|
|
#: Hide the window decorations (title-bar and window borders) with
|
|
#: yes. On macOS, titlebar-only can be used to only hide the titlebar.
|
|
#: Whether this works and exactly what effect it has depends on the
|
|
#: window manager/operating system. Note that the effects of changing
|
|
#: this option when reloading config are undefined.
|
|
|
|
window_logo_path none
|
|
|
|
#: Path to a logo image. Must be in PNG format. Relative paths are
|
|
#: interpreted relative to the kitty config directory. The logo is
|
|
#: displayed in a corner of every kitty window. The position is
|
|
#: controlled by window_logo_position. Individual windows can be
|
|
#: configured to have different logos either using the launch action
|
|
#: or the remote control <https://sw.kovidgoyal.net/kitty/remote-
|
|
#: control/> facility.
|
|
|
|
window_logo_position bottom-right
|
|
|
|
#: Where to position the window logo in the window. The value can be
|
|
#: one of: top-left, top, top-right, left, center, right, bottom-left,
|
|
#: bottom, bottom-right.
|
|
|
|
window_logo_alpha 0.5
|
|
|
|
#: The amount the logo should be faded into the background. With zero
|
|
#: being fully faded and one being fully opaque.
|
|
|
|
resize_debounce_time 0.1
|
|
|
|
#: The time to wait before redrawing the screen when a resize event is
|
|
#: received (in seconds). On platforms such as macOS, where the
|
|
#: operating system sends events corresponding to the start and end of
|
|
#: a resize, this number is ignored.
|
|
|
|
resize_draw_strategy static
|
|
|
|
#: Choose how kitty draws a window while a resize is in progress. A
|
|
#: value of static means draw the current window contents, mostly
|
|
#: unchanged. A value of scale means draw the current window contents
|
|
#: scaled. A value of blank means draw a blank window. A value of size
|
|
#: means show the window size in cells.
|
|
|
|
resize_in_steps no
|
|
|
|
#: Resize the OS window in steps as large as the cells, instead of
|
|
#: with the usual pixel accuracy. Combined with initial_window_width
|
|
#: and initial_window_height in number of cells, this option can be
|
|
#: used to keep the margins as small as possible when resizing the OS
|
|
#: window. Note that this does not currently work on Wayland.
|
|
|
|
visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
|
|
|
|
#: The list of characters for visual window selection. For example,
|
|
#: for selecting a window to focus on with focus_visible_window. The
|
|
#: value should be a series of unique numbers or alphabets, case
|
|
#: insensitive, from the set [0-9A-Z]. Specify your preference as a
|
|
#: string of characters.
|
|
|
|
confirm_os_window_close 0
|
|
|
|
#: Ask for confirmation when closing an OS window or a tab with at
|
|
#: least this number of kitty windows in it by window manager (e.g.
|
|
#: clicking the window close button or pressing the operating system
|
|
#: shortcut to close windows) or by the close_tab action. A value of
|
|
#: zero disables confirmation. This confirmation also applies to
|
|
#: requests to quit the entire application (all OS windows, via the
|
|
#: quit action). Negative values are converted to positive ones,
|
|
#: however, with shell_integration enabled, using negative values
|
|
#: means windows sitting at a shell prompt are not counted, only
|
|
#: windows where some command is currently running. Note that if you
|
|
#: want confirmation when closing individual windows, you can map the
|
|
#: close_window_with_confirmation action.
|
|
|
|
#: }}}
|
|
|
|
#: Tab bar {{{
|
|
|
|
tab_bar_edge bottom
|
|
|
|
#: The edge to show the tab bar on, top or bottom.
|
|
|
|
tab_bar_margin_width 0.0
|
|
|
|
#: The margin to the left and right of the tab bar (in pts).
|
|
|
|
tab_bar_margin_height 0.0 0.0
|
|
|
|
#: The margin above and below the tab bar (in pts). The first number
|
|
#: is the margin between the edge of the OS Window and the tab bar.
|
|
#: The second number is the margin between the tab bar and the
|
|
#: contents of the current tab.
|
|
|
|
tab_bar_style powerline
|
|
|
|
#: The tab bar style, can be one of:
|
|
|
|
#: fade
|
|
#: Each tab's edges fade into the background color. (See also tab_fade)
|
|
#: slant
|
|
#: Tabs look like the tabs in a physical file.
|
|
#: separator
|
|
#: Tabs are separated by a configurable separator. (See also
|
|
#: tab_separator)
|
|
#: powerline
|
|
#: Tabs are shown as a continuous line with "fancy" separators.
|
|
#: (See also tab_powerline_style)
|
|
#: custom
|
|
#: A user-supplied Python function called draw_tab is loaded from the file
|
|
#: tab_bar.py in the kitty config directory. For examples of how to
|
|
#: write such a function, see the functions named draw_tab_with_* in
|
|
#: kitty's source code: kitty/tab_bar.py. See also
|
|
#: this discussion https://github.com/kovidgoyal/kitty/discussions/4447
|
|
#: for examples from kitty users.
|
|
#: hidden
|
|
#: The tab bar is hidden. If you use this, you might want to create a mapping
|
|
#: for the select_tab action which presents you with a list of tabs and
|
|
#: allows for easy switching to a tab.
|
|
|
|
tab_bar_align left
|
|
|
|
#: The horizontal alignment of the tab bar, can be one of: left,
|
|
#: center, right.
|
|
|
|
tab_bar_min_tabs 2
|
|
|
|
#: The minimum number of tabs that must exist before the tab bar is
|
|
#: shown.
|
|
|
|
tab_switch_strategy previous
|
|
|
|
#: The algorithm to use when switching to a tab when the current tab
|
|
#: is closed. The default of previous will switch to the last used
|
|
#: tab. A value of left will switch to the tab to the left of the
|
|
#: closed tab. A value of right will switch to the tab to the right of
|
|
#: the closed tab. A value of last will switch to the right-most tab.
|
|
|
|
tab_fade 0.25 0.5 0.75 1
|
|
|
|
#: Control how each tab fades into the background when using fade for
|
|
#: the tab_bar_style. Each number is an alpha (between zero and one)
|
|
#: that controls how much the corresponding cell fades into the
|
|
#: background, with zero being no fade and one being full fade. You
|
|
#: can change the number of cells used by adding/removing entries to
|
|
#: this list.
|
|
|
|
tab_separator " ┇"
|
|
|
|
#: The separator between tabs in the tab bar when using separator as
|
|
#: the tab_bar_style.
|
|
|
|
tab_powerline_style slanted
|
|
|
|
#: The powerline separator style between tabs in the tab bar when
|
|
#: using powerline as the tab_bar_style, can be one of: angled,
|
|
#: slanted, round.
|
|
|
|
tab_activity_symbol none
|
|
|
|
#: Some text or a Unicode symbol to show on the tab if a window in the
|
|
#: tab that does not have focus has some activity. If you want to use
|
|
#: leading or trailing spaces, surround the text with quotes. See
|
|
#: tab_title_template for how this is rendered.
|
|
|
|
tab_title_template "{f'{title[:30]}…' if title.rindex(title[-1]) + 1 > 30 else (title.center(6) if (title.rindex(title[-1]) + 1) % 2 == 0 else title.center(5))}"
|
|
|
|
#: A template to render the tab title. The default just renders the
|
|
#: title with optional symbols for bell and activity. If you wish to
|
|
#: include the tab-index as well, use something like: {index}:{title}.
|
|
#: Useful if you have shortcuts mapped for goto_tab N. If you prefer
|
|
#: to see the index as a superscript, use {sup.index}. In addition you
|
|
#: can use {layout_name} for the current layout name, {num_windows}
|
|
#: for the number of windows in the tab and {num_window_groups} for
|
|
#: the number of window groups (not counting overlay windows) in the
|
|
#: tab. Note that formatting is done by Python's string formatting
|
|
#: machinery, so you can use, for instance, {layout_name[:2].upper()}
|
|
#: to show only the first two letters of the layout name, upper-cased.
|
|
#: If you want to style the text, you can use styling directives, for
|
|
#: example:
|
|
#: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`.
|
|
#: Similarly, for bold and italic:
|
|
#: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`.
|
|
#: Note that for backward compatibility, if {bell_symbol} or
|
|
#: {activity_symbol} are not present in the template, they are
|
|
#: prepended to it.
|
|
|
|
active_tab_title_template none
|
|
|
|
#: Template to use for active tabs. If not specified falls back to
|
|
#: tab_title_template.
|
|
active_tab_foreground #1e2030
|
|
active_tab_background #b7bdf8
|
|
inactive_tab_foreground #CAD3F5
|
|
inactive_tab_background #1E2030
|
|
tab_bar_background #1e2030
|
|
active_tab_font_style bold-italic
|
|
inactive_tab_font_style normal
|
|
|
|
#: Tab bar colors and styles.
|
|
|
|
#: Background color for the tab bar. Defaults to using the terminal
|
|
#: background color.
|
|
|
|
tab_bar_margin_color #1e2030
|
|
|
|
#: Color for the tab bar margin area. Defaults to using the terminal
|
|
#: background color.
|
|
|
|
#: }}}
|
|
|
|
#: Color scheme {{{
|
|
|
|
foreground #CAD3F5
|
|
background #24273A
|
|
|
|
#: The foreground and background colors.
|
|
|
|
background_opacity 0.7
|
|
|
|
#: The opacity of the background. A number between zero and one, where
|
|
#: one is opaque and zero is fully transparent. This will only work if
|
|
#: supported by the OS (for instance, when using a compositor under
|
|
#: X11). Note that it only sets the background color's opacity in
|
|
#: cells that have the same background color as the default terminal
|
|
#: background, so that things like the status bar in vim, powerline
|
|
#: prompts, etc. still look good. But it means that if you use a color
|
|
#: theme with a background color in your editor, it will not be
|
|
#: rendered as transparent. Instead you should change the default
|
|
#: background color in your kitty config and not use a background
|
|
#: color in the editor color scheme. Or use the escape codes to set
|
|
#: the terminals default colors in a shell script to launch your
|
|
#: editor. Be aware that using a value less than 1.0 is a (possibly
|
|
#: significant) performance hit. If you want to dynamically change
|
|
#: transparency of windows, set dynamic_background_opacity to yes
|
|
#: (this is off by default as it has a performance cost). Changing
|
|
#: this option when reloading the config will only work if
|
|
#: dynamic_background_opacity was enabled in the original config.
|
|
|
|
background_image none
|
|
|
|
#: Path to a background image. Must be in PNG format.
|
|
|
|
background_image_layout tiled
|
|
|
|
#: Whether to tile, scale or clamp the background image. The value can
|
|
#: be one of tiled, mirror-tiled, scaled, clamped.
|
|
|
|
background_image_linear no
|
|
|
|
#: When background image is scaled, whether linear interpolation
|
|
#: should be used.
|
|
|
|
dynamic_background_opacity no
|
|
|
|
#: Allow changing of the background_opacity dynamically, using either
|
|
#: keyboard shortcuts (increase_background_opacity and
|
|
#: decrease_background_opacity) or the remote control facility.
|
|
#: Changing this option by reloading the config is not supported.
|
|
|
|
background_tint 0.0
|
|
|
|
#: How much to tint the background image by the background color. The
|
|
#: tint is applied only under the text area, not margin/borders. This
|
|
#: option makes it easier to read the text. Tinting is done using the
|
|
#: current background color for each window. This option applies only
|
|
#: if background_opacity is set and transparent windows are supported
|
|
#: or background_image is set.
|
|
|
|
dim_opacity 0.75
|
|
|
|
#: How much to dim text that has the DIM/FAINT attribute set. One
|
|
#: means no dimming and zero means fully dimmed (i.e. invisible).
|
|
|
|
selection_foreground #24273A
|
|
selection_background #F4DBD6
|
|
|
|
#: The foreground and background colors for text selected with the
|
|
#: mouse. Setting both of these to none will cause a "reverse video"
|
|
#: effect for selections, where the selection will be the cell text
|
|
#: color and the text will become the cell background color. Setting
|
|
#: only selection_foreground to none will cause the foreground color
|
|
#: to be used unchanged. Note that these colors can be overridden by
|
|
#: the program running in the terminal.
|
|
|
|
#: The color table {{{
|
|
|
|
#: The 256 terminal colors. There are 8 basic colors, each color has a
|
|
#: dull and bright version, for the first 16 colors. You can set the
|
|
#: remaining 240 colors as color16 to color255.
|
|
|
|
# black
|
|
color0 #494D64
|
|
color8 #5B6078
|
|
|
|
# red
|
|
color1 #ED8796
|
|
color9 #ED8796
|
|
|
|
# green
|
|
color2 #A6DA95
|
|
color10 #A6DA95
|
|
|
|
# yellow
|
|
color3 #EED49F
|
|
color11 #EED49F
|
|
|
|
# blue
|
|
color4 #8AADF4
|
|
color12 #8AADF4
|
|
|
|
# magenta
|
|
color5 #F5BDE6
|
|
color13 #F5BDE6
|
|
|
|
# cyan
|
|
color6 #8BD5CA
|
|
color14 #8BD5CA
|
|
|
|
# white
|
|
color7 #B8C0E0
|
|
color15 #A5ADCB
|
|
|
|
mark1_foreground #24273A
|
|
mark1_background #B7BDF8
|
|
mark2_foreground #24273A
|
|
mark2_background #C6A0F6
|
|
mark3_foreground #24273A
|
|
mark3_background #7DC4E4
|
|
|
|
#: Color for marks of type 3 (violet)
|
|
|
|
#: }}}
|
|
|
|
#: }}}
|
|
|
|
#: Advanced {{{
|
|
|
|
shell zsh
|
|
|
|
#: The shell program to execute. The default value of . means to use
|
|
#: whatever shell is set as the default shell for the current user.
|
|
#: Note that on macOS if you change this, you might need to add
|
|
#: --login and --interactive to ensure that the shell starts in
|
|
#: interactive mode and reads its startup rc files.
|
|
|
|
editor nvim
|
|
|
|
#: The terminal based text editor (such as vim or nano) to use when
|
|
#: editing the kitty config file or similar tasks.
|
|
|
|
#: The default value of . means to use the environment variables
|
|
#: VISUAL and EDITOR in that order. If these variables aren't set,
|
|
#: kitty will run your shell ($SHELL -l -i -c env) to see if your
|
|
#: shell startup rc files set VISUAL or EDITOR. If that doesn't work,
|
|
#: kitty will cycle through various known editors (vim, emacs, etc.)
|
|
#: and take the first one that exists on your system.
|
|
|
|
close_on_child_death no
|
|
|
|
#: Close the window when the child process (shell) exits. With the
|
|
#: default value no, the terminal will remain open when the child
|
|
#: exits as long as there are still processes outputting to the
|
|
#: terminal (for example disowned or backgrounded processes). When
|
|
#: enabled with yes, the window will close as soon as the child
|
|
#: process exits. Note that setting it to yes means that any
|
|
#: background processes still using the terminal can fail silently
|
|
#: because their stdout/stderr/stdin no longer work.
|
|
|
|
allow_remote_control yes
|
|
|
|
#: Allow other programs to control kitty. If you turn this on, other
|
|
#: programs can control all aspects of kitty, including sending text
|
|
#: to kitty windows, opening new windows, closing windows, reading the
|
|
#: content of windows, etc. Note that this even works over SSH
|
|
#: connections. You can choose to either allow any program running
|
|
#: within kitty to control it with yes, or only allow programs that
|
|
#: connect to the socket (specified with the listen_on config option
|
|
#: or kitty --listen-on command line option) with the value socket-
|
|
#: only. The latter is useful if you want to prevent programs running
|
|
#: on a remote computer over SSH from controlling kitty. Reloading the
|
|
#: config will not affect this option.
|
|
|
|
listen_on unix:@mykitty
|
|
|
|
#: Listen to the specified UNIX socket for remote control connections.
|
|
#: Note that this will apply to all kitty instances. It can be
|
|
#: overridden by the kitty --listen-on command line option, which
|
|
#: supports listening on TCP socket. This option accepts only UNIX
|
|
#: sockets, such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux).
|
|
#: Environment variables are expanded and relative paths are resolved
|
|
#: with respect to the temporary directory. If {kitty_pid} is present,
|
|
#: then it is replaced by the PID of the kitty process, otherwise the
|
|
#: PID of the kitty process is appended to the value, with a hyphen.
|
|
#: This option is ignored unless you also set allow_remote_control to
|
|
#: enable remote control. See the help for kitty --listen-on for more
|
|
#: details. Changing this option by reloading the config is not
|
|
#: supported.
|
|
|
|
# env
|
|
|
|
#: Specify the environment variables to be set in all child processes.
|
|
#: Using the name with an equal sign (e.g. env VAR=) will set it to
|
|
#: the empty string. Specifying only the name (e.g. env VAR) will
|
|
#: remove the variable from the child process' environment. Note that
|
|
#: environment variables are expanded recursively, for example::
|
|
|
|
#: env VAR1=a
|
|
#: env VAR2=${HOME}/${VAR1}/b
|
|
|
|
#: The value of VAR2 will be <path to home directory>/a/b.
|
|
|
|
# watcher
|
|
|
|
#: Path to python file which will be loaded for watchers
|
|
#: <https://sw.kovidgoyal.net/kitty/launch/#watchers>. Can be
|
|
#: specified more than once to load multiple watchers. The watchers
|
|
#: will be added to every kitty window. Relative paths are resolved
|
|
#: relative to the kitty config directory. Note that reloading the
|
|
#: config will only affect windows created after the reload.
|
|
|
|
# exe_search_path
|
|
|
|
#: Control where kitty finds the programs to run. The default search
|
|
#: order is: First search the system wide PATH, then ~/.local/bin and
|
|
#: ~/bin. If still not found, the PATH defined in the login shell
|
|
#: after sourcing all its startup files is tried. Finally, if present,
|
|
#: the PATH specified by the env option is tried.
|
|
|
|
#: This option allows you to prepend, append, or remove paths from
|
|
#: this search order. It can be specified multiple times for multiple
|
|
#: paths. A simple path will be prepended to the search order. A path
|
|
#: that starts with the + sign will be append to the search order,
|
|
#: after ~/bin above. A path that starts with the - sign will be
|
|
#: removed from the entire search order. For example::
|
|
|
|
#: exe_search_path /some/prepended/path
|
|
#: exe_search_path +/some/appended/path
|
|
#: exe_search_path -/some/excluded/path
|
|
|
|
update_check_interval 24
|
|
|
|
#: The interval to periodically check if an update to kitty is
|
|
#: available (in hours). If an update is found, a system notification
|
|
#: is displayed informing you of the available update. The default is
|
|
#: to check every 24 hours, set to zero to disable. Update checking is
|
|
#: only done by the official binary builds. Distro packages or source
|
|
#: builds do not do update checking. Changing this option by reloading
|
|
#: the config is not supported.
|
|
|
|
startup_session none
|
|
|
|
#: Path to a session file to use for all kitty instances. Can be
|
|
#: overridden by using the kitty --session command line option for
|
|
#: individual instances. See sessions
|
|
#: <https://sw.kovidgoyal.net/kitty/overview/#startup-sessions> in the
|
|
#: kitty documentation for details. Note that relative paths are
|
|
#: interpreted with respect to the kitty config directory. Environment
|
|
#: variables in the path are expanded. Changing this option by
|
|
#: reloading the config is not supported.
|
|
|
|
clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask
|
|
|
|
#: Allow programs running in kitty to read and write from the
|
|
#: clipboard. You can control exactly which actions are allowed. The
|
|
#: possible actions are: write-clipboard, read-clipboard, write-
|
|
#: primary, read-primary, read-clipboard-ask, read-primary-ask. The
|
|
#: default is to allow writing to the clipboard and primary selection
|
|
#: and to ask for permission when a program tries to read from the
|
|
#: clipboard. Note that disabling the read confirmation is a security
|
|
#: risk as it means that any program, even the ones running on a
|
|
#: remote server via SSH can read your clipboard. See also
|
|
#: clipboard_max_size.
|
|
|
|
clipboard_max_size 64
|
|
|
|
#: The maximum size (in MB) of data from programs running in kitty
|
|
#: that will be stored for writing to the system clipboard. A value of
|
|
#: zero means no size limit is applied. See also clipboard_control.
|
|
|
|
# file_transfer_confirmation_bypass
|
|
|
|
#: The password that can be supplied to the file transfer kitten
|
|
#: <https://sw.kovidgoyal.net/kitty/kittens/transfer/> to skip the
|
|
#: transfer confirmation prompt. This should only be used when
|
|
#: initiating transfers from trusted computers, over trusted networks
|
|
#: or encrypted transports, as it allows any programs running on the
|
|
#: remote machine to read/write to the local filesystem, without
|
|
#: permission.
|
|
|
|
allow_hyperlinks yes
|
|
|
|
#: Process hyperlink escape sequences (OSC 8). If disabled OSC 8
|
|
#: escape sequences are ignored. Otherwise they become clickable
|
|
#: links, that you can click with the mouse or by using the hints
|
|
#: kitten <https://sw.kovidgoyal.net/kitty/kittens/hints/>. The
|
|
#: special value of ask means that kitty will ask before opening the
|
|
#: link when clicked.
|
|
|
|
shell_integration enabled
|
|
|
|
#: Enable shell integration on supported shells. This enables features
|
|
#: such as jumping to previous prompts, browsing the output of the
|
|
#: previous command in a pager, etc. on supported shells. Set to
|
|
#: disabled to turn off shell integration, completely. It is also
|
|
#: possible to disable individual features, set to a space separated
|
|
#: list of these values: no-rc, no-cursor, no-title, no-cwd, no-
|
|
#: prompt-mark, no-complete. See Shell integration
|
|
#: <https://sw.kovidgoyal.net/kitty/shell-integration/> for details.
|
|
|
|
allow_cloning ask
|
|
|
|
#: Control whether programs running in the terminal can request new
|
|
#: windows to be created. The canonical example is clone-in-kitty
|
|
#: <https://sw.kovidgoyal.net/kitty/shell-integration/#clone-shell>.
|
|
#: By default, kitty will ask for permission for each clone request.
|
|
#: Allowing cloning unconditionally gives programs running in the
|
|
#: terminal (including over SSH) permission to execute arbitrary code,
|
|
#: as the user who is running the terminal, on the computer that the
|
|
#: terminal is running on.
|
|
|
|
clone_source_strategies venv,conda,env_var,path
|
|
|
|
#: Control what shell code is sourced when running clone-in-kitty in
|
|
#: the newly cloned window. The supported strategies are:
|
|
|
|
#: venv
|
|
#: Source the file $VIRTUAL_ENV/bin/activate. This is used by the
|
|
#: Python stdlib venv module and allows cloning venvs automatically.
|
|
#: conda
|
|
#: Run conda activate $CONDA_DEFAULT_ENV. This supports the virtual
|
|
#: environments created by conda.
|
|
#: env_var
|
|
#: Execute the contents of the environment variable
|
|
#: KITTY_CLONE_SOURCE_CODE with eval.
|
|
#: path
|
|
#: Source the file pointed to by the environment variable
|
|
#: KITTY_CLONE_SOURCE_PATH.
|
|
|
|
#: This option must be a comma separated list of the above values.
|
|
#: This only source the first valid one in the above order.
|
|
|
|
term xterm-kitty
|
|
|
|
#: The value of the TERM environment variable to set. Changing this
|
|
#: can break many terminal programs, only change it if you know what
|
|
#: you are doing, not because you read some advice on "Stack Overflow"
|
|
#: to change it. The TERM variable is used by various programs to get
|
|
#: information about the capabilities and behavior of the terminal. If
|
|
#: you change it, depending on what programs you run, and how
|
|
#: different the terminal you are changing it to is, various things
|
|
#: from key-presses, to colors, to various advanced features may not
|
|
#: work. Changing this option by reloading the config will only affect
|
|
#: newly created windows.
|
|
|
|
#: }}}
|
|
|
|
#: OS specific tweaks {{{
|
|
|
|
wayland_titlebar_color system
|
|
|
|
#: The color of the kitty window's titlebar on Wayland systems with
|
|
#: client side window decorations such as GNOME. A value of system
|
|
#: means to use the default system color, a value of background means
|
|
#: to use the background color of the currently active window and
|
|
#: finally you can use an arbitrary color, such as #12af59 or red.
|
|
|
|
macos_titlebar_color system
|
|
|
|
#: The color of the kitty window's titlebar on macOS. A value of
|
|
#: system means to use the default system color, light or dark can
|
|
#: also be used to set it explicitly. A value of background means to
|
|
#: use the background color of the currently active window and finally
|
|
#: you can use an arbitrary color, such as #12af59 or red. WARNING:
|
|
#: This option works by using a hack when arbitrary color (or
|
|
#: background) is configured, as there is no proper Cocoa API for it.
|
|
#: It sets the background color of the entire window and makes the
|
|
#: titlebar transparent. As such it is incompatible with
|
|
#: background_opacity. If you want to use both, you are probably
|
|
#: better off just hiding the titlebar with hide_window_decorations.
|
|
|
|
macos_option_as_alt no
|
|
|
|
#: Use the Option key as an Alt key on macOS. With this set to no,
|
|
#: kitty will use the macOS native Option+Key to enter Unicode
|
|
#: character behavior. This will break any Alt+Key keyboard shortcuts
|
|
#: in your terminal programs, but you can use the macOS Unicode input
|
|
#: technique. You can use the values: left, right or both to use only
|
|
#: the left, right or both Option keys as Alt, instead. Note that
|
|
#: kitty itself always treats Option the same as Alt. This means you
|
|
#: cannot use this option to configure different kitty shortcuts for
|
|
#: Option+Key vs. Alt+Key. Also, any kitty shortcuts using
|
|
#: Option/Alt+Key will take priority, so that any such key presses
|
|
#: will not be passed to terminal programs running inside kitty.
|
|
#: Changing this option by reloading the config is not supported.
|
|
|
|
macos_hide_from_tasks no
|
|
|
|
#: Hide the kitty window from running tasks on macOS (⌘+Tab and the
|
|
#: Dock). Changing this option by reloading the config is not
|
|
#: supported.
|
|
|
|
macos_quit_when_last_window_closed no
|
|
|
|
#: Have kitty quit when all the top-level windows are closed on macOS.
|
|
#: By default, kitty will stay running, even with no open windows, as
|
|
#: is the expected behavior on macOS.
|
|
|
|
macos_window_resizable yes
|
|
|
|
#: Disable this if you want kitty top-level OS windows to not be
|
|
#: resizable on macOS. Changing this option by reloading the config
|
|
#: will only affect newly created OS windows.
|
|
|
|
macos_thicken_font 0
|
|
|
|
#: Draw an extra border around the font with the given width, to
|
|
#: increase legibility at small font sizes on macOS. For example, a
|
|
#: value of 0.75 will result in rendering that looks similar to sub-
|
|
#: pixel antialiasing at common font sizes.
|
|
|
|
macos_traditional_fullscreen no
|
|
|
|
#: Use the macOS traditional full-screen transition, that is faster,
|
|
#: but less pretty.
|
|
|
|
macos_show_window_title_in all
|
|
|
|
#: Control where the window title is displayed on macOS. A value of
|
|
#: window will show the title of the currently active window at the
|
|
#: top of the macOS window. A value of menubar will show the title of
|
|
#: the currently active window in the macOS global menu bar, making
|
|
#: use of otherwise wasted space. A value of all will show the title
|
|
#: in both places, and none hides the title. See
|
|
#: macos_menubar_title_max_length for how to control the length of the
|
|
#: title in the menu bar.
|
|
|
|
macos_menubar_title_max_length 0
|
|
|
|
#: The maximum number of characters from the window title to show in
|
|
#: the macOS global menu bar. Values less than one means that there is
|
|
#: no maximum limit.
|
|
|
|
macos_custom_beam_cursor no
|
|
|
|
#: Use a custom mouse cursor for macOS that is easier to see on both
|
|
#: light and dark backgrounds. Nowadays, the default macOS cursor
|
|
#: already comes with a white border. WARNING: this might make your
|
|
#: mouse cursor invisible on dual GPU machines. Changing this option
|
|
#: by reloading the config is not supported.
|
|
|
|
macos_colorspace srgb
|
|
|
|
#: The colorspace in which to interpret terminal colors. The default
|
|
#: of srgb will cause colors to match those seen in web browsers. The
|
|
#: value of default will use whatever the native colorspace of the
|
|
#: display is. The value of displayp3 will use Apple's special
|
|
#: snowflake display P3 color space, which will result in over
|
|
#: saturated (brighter) colors with some color shift. Reloading
|
|
#: configuration will change this value only for newly created OS
|
|
#: windows.
|
|
|
|
linux_display_server auto
|
|
|
|
#: Choose between Wayland and X11 backends. By default, an appropriate
|
|
#: backend based on the system state is chosen automatically. Set it
|
|
#: to x11 or wayland to force the choice. Changing this option by
|
|
#: reloading the config is not supported.
|
|
|
|
#: }}}
|
|
|
|
#: Keyboard shortcuts {{{
|
|
|
|
map ctrl+v paste_from_clipboard
|
|
map ctrl+c copy_and_clear_or_interrupt
|
|
map ctrl+backspace send_text all \x17
|
|
|
|
# Scrolling
|
|
map ctrl+shift+k scroll_line_up
|
|
map ctrl+shift+j scroll_line_down
|
|
map ctrl+shift+page_up scroll_page_up
|
|
map ctrl+shift+page_down scroll_page_down
|
|
map ctrl+shift+home scroll_home
|
|
map ctrl+shift+end scroll_end
|
|
map ctrl+shift+h show_scrollback
|
|
|
|
# Window management
|
|
map ctrl+shift+n new_os_window
|
|
map ctrl+w close_window
|
|
map ctrl+enter no_op
|
|
map ctrl+] next_window
|
|
map ctrl+[ previous_window
|
|
map alt+h move_window_forward
|
|
map alt+l move_window_backward
|
|
map alt+` move_window_to_top
|
|
map alt+1 first_window
|
|
map alt+2 second_window
|
|
map alt+3 third_window
|
|
map alt+4 fourth_window
|
|
map alt+5 fifth_window
|
|
map alt+6 sixth_window
|
|
map alt+7 seventh_window
|
|
map alt+8 eighth_window
|
|
map alt+9 ninth_window
|
|
|
|
map ctrl+- launch --location=hsplit
|
|
map ctrl+\ launch --location=vsplit
|
|
map F8 layout_action rotate
|
|
|
|
map shift+up move_window up
|
|
map shift+left move_window left
|
|
map shift+right move_window right
|
|
map shift+down move_window down
|
|
|
|
map ctrl+shift+left neighboring_window left
|
|
map ctrl+shift+right neighboring_window right
|
|
map ctrl+shift+up neighboring_window up
|
|
map ctrl+shift+down neighboring_window down
|
|
|
|
# Tab management
|
|
map ctrl+tab next_tab
|
|
map ctrl+shift+tab previous_tab
|
|
map ctrl+t new_tab
|
|
map ctrl+q close_tab
|
|
map F2 set_tab_title
|
|
map ctrl+shift+l next_layout
|
|
map ctrl+shift+. move_tab_forward
|
|
map ctrl+shift+, move_tab_backward
|
|
|
|
# Miscellaneous
|
|
map ctrl+KP_Add increase_font_size
|
|
map ctrl+KP_Subtract decrease_font_size
|
|
map ctrl+KP_0 restore_font_size
|
|
map ctrl+f launch --location=hsplit --allow-remote-control kitty +kitten search.py @active-kitty-window-id
|
|
map f5 load_config_file
|
|
map f6 debug_config
|
|
|
|
#: Open kitty Website
|
|
|
|
map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/
|
|
|
|
map shift+down kitten pass_keys.py neighboring_window bottom shift+down
|
|
map shift+up kitten pass_keys.py neighboring_window top shift+up
|
|
map shift+left kitten pass_keys.py neighboring_window left shift+left
|
|
map shift+right kitten pass_keys.py neighboring_window right shift+right
|
|
|
|
# the 3 here is the resize amount, adjust as needed
|
|
map ctrl+alt+down kitten pass_keys.py relative_resize down 3 ctrl+alt+down
|
|
map ctrl+alt+up kitten pass_keys.py relative_resize up 3 ctrl+alt+up
|
|
map ctrl+alt+left kitten pass_keys.py relative_resize left 3 ctrl+alt+left
|
|
map ctrl+alt+right kitten pass_keys.py relative_resize right 3 ctrl+alt+right
|
|
|
|
# kitty-scrollback.nvim Kitten alias
|
|
action_alias kitty_scrollback_nvim kitten $HOME/.local/share/nvim/lazy/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py
|
|
|
|
# Browse scrollback buffer in nvim
|
|
map kitty_mod+h kitty_scrollback_nvim
|
|
# Browse output of the last shell command in nvim
|
|
map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
|
|
# Show clicked command output in nvim
|
|
mouse_map ctrl+shift+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output
|
|
|
|
#: }}}
|
|
|
|
#: }}}
|