Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.kitty.enable

Whether to enable Kitty terminal emulator.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.kitty.enableGitIntegration

Whether to enable git integration.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.kitty.package

The kitty package to use.

Type: null or package

Default:

pkgs.kitty

Declared by:

programs.kitty.actionAliases

Define action aliases.

Type: attribute set of string

Default:

{ }

Example:

{
  launch_tab = "launch --cwd=current --type=tab";
  launch_window = "launch --cwd=current --type=os-window";
}

Declared by:

programs.kitty.autoThemeFiles

Configure Kitty automatic color themes. This creates $XDG_CONFIG_HOME/kitty/light-theme.auto.conf, $XDG_CONFIG_HOME/kitty/dark-theme.auto.conf, and $XDG_CONFIG_HOME/kitty/no-preference-theme.auto.conf. Kitty applies these based on the OS color scheme, and they override other color and background image settings.

Type: null or (submodule)

Default:

null

Example:

{
  dark = "TokyoNight";
  light = "GitHub";
  noPreference = "OneDark";
}

Declared by:

programs.kitty.autoThemeFiles.dark

Theme name for dark color scheme.

Type: string

Declared by:

programs.kitty.autoThemeFiles.light

Theme name for light color scheme.

Type: string

Declared by:

programs.kitty.autoThemeFiles.noPreference

Theme name for no-preference color scheme.

Type: string

Declared by:

programs.kitty.darwinLaunchOptions

Command-line options to use when launched by Mac OS GUI

Type: null or (list of string)

Default:

null

Example:

[
  "--single-instance"
  "--directory=/tmp/my-dir"
  "--listen-on=unix:/tmp/my-socket"
]

Declared by:

programs.kitty.diffConfig.extraConfig

Additional configuration to add kitty’s diff.conf

Type: strings concatenated with “\n”

Default:

""

Declared by:

programs.kitty.diffConfig.keybindings

Mapping of keybindings to use inside kitty’s diff tool.

Configuration set through the extraConfig options will take greater priority.

Type: attribute set of string

Default:

{ }

Example:

q = "quit";
j = "scroll_by 1";
k = "scroll_by -1";

Declared by:

programs.kitty.diffConfig.settings

Configuration written to $XDG_CONFIG_HOME/kitty/diff.conf. See https://sw.kovidgoyal.net/kitty/kittens/diff/ for the documentation.

Configuration set through the extraConfig option will take greater priority.

Type: attribute set of (string or boolean or signed integer or floating point number)

Default:

{ }

Example:

diff_cmd = "auto";
mark_moved_lines = true;

Declared by:

programs.kitty.environment

Environment variables to set or override.

Type: attribute set of string

Default:

{ }

Example:

{
  LS_COLORS = "1";
}

Declared by:

programs.kitty.extraConfig

Additional configuration to add to kitty.conf.

Type: strings concatenated with “\n”

Default:

""

Declared by:

programs.kitty.font

The font to use.

Type: null or (submodule)

Default:

null

Declared by:

programs.kitty.font.package

Package providing the font. This package will be installed to your profile. If null then the font is assumed to already be available in your profile.

Type: null or package

Default:

null

Example:

pkgs.dejavu_fonts

Declared by:

programs.kitty.font.name

The family name of the font within the package.

Type: string

Example:

"DejaVu Sans"

Declared by:

programs.kitty.font.size

The size of the font.

Type: null or signed integer or floating point number

Default:

null

Example:

"8"

Declared by:

programs.kitty.keybindings

Mapping of keybindings to actions.

Type: attribute set of string

Default:

{ }

Example:

{
  "ctrl+c" = "copy_or_interrupt";
  "ctrl+f>2" = "set_font_size 20";
}

Declared by:

programs.kitty.mouseBindings

Mapping of mouse bindings to actions.

Type: attribute set of string

Default:

{ }

Example:

{
  "ctrl+left click" = "ungrabbed mouse_handle_click selection link prompt";
  "left click" = "ungrabbed no-op";
};

Declared by:

programs.kitty.quickAccessTerminalConfig

Configuration written to $XDG_CONFIG_HOME/kitty/quick-access-terminal.conf. See https://sw.kovidgoyal.net/kitty/kittens/quick-access-terminal/ for the documentation.

Type: attribute set of (string or boolean or signed integer or floating point number)

Default:

{ }

Example:

{
  background_opacity = 0.85;
  hide_on_focus_loss = false;
  start_as_hidden = false;
}

Declared by:

programs.kitty.settings

Configuration written to $XDG_CONFIG_HOME/kitty/kitty.conf. See https://sw.kovidgoyal.net/kitty/conf.html for the documentation.

Type: attribute set of (string or boolean or signed integer or floating point number)

Default:

{ }

Example:

{
  enable_audio_bell = false;
  scrollback_lines = 10000;
  update_check_interval = 0;
}

Declared by:

programs.kitty.shellIntegration.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default:

(cfg.shellIntegration.mode != null)
&& !(elem "disabled" (splitString " " config.programs.kitty.shellIntegration.mode))

Example:

false

Declared by:

programs.kitty.shellIntegration.enableFishIntegration

Whether to enable Fish integration.

Type: boolean

Default:

(cfg.shellIntegration.mode != null)
&& !(elem "disabled" (splitString " " config.programs.kitty.shellIntegration.mode))

Example:

false

Declared by:

programs.kitty.shellIntegration.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default:

(cfg.shellIntegration.mode != null)
&& !(elem "disabled" (splitString " " config.programs.kitty.shellIntegration.mode))

Example:

false

Declared by:

programs.kitty.shellIntegration.mode

Set the mode of the shell integration. This accepts the same options as the shell_integration option of Kitty. Note that no-rc is always implied, unless this set to null. See https://sw.kovidgoyal.net/kitty/shell-integration for more details.

Type: null or string

Default:

"no-rc"

Example:

"no-cursor"

Declared by:

programs.kitty.themeFile

Apply a Kitty color theme. This option takes the file name of a theme in kitty-themes, without the .conf suffix. See https://github.com/kovidgoyal/kitty-themes/tree/master/themes for a list of themes.

Note that if any automatic themes are configured via programs.kitty.autoThemeFiles, Kitty will prefer them based on the OS color scheme and they will override other color and background image settings.

Type: null or string

Default:

null

Example:

"SpaceGray_Eighties"

Declared by: