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.ghostty.enable

Whether to enable Ghostty.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.ghostty.enableBashIntegration

Whether to enable Bash integration.

This ensures that shell integration works in more scenarios, such as switching shells within Ghostty. But it is not needed to have shell integration.

See https://ghostty.org/docs/features/shell-integration#manual-shell-integration-setup for more information.

Type: boolean

Default:

Example:

false

Declared by:

programs.ghostty.enableFishIntegration

Whether to enable Fish integration.

This ensures that shell integration works in more scenarios, such as switching shells within Ghostty. But it is not needed to have shell integration.

See https://ghostty.org/docs/features/shell-integration#manual-shell-integration-setup for more information.

Type: boolean

Default:

Example:

false

Declared by:

programs.ghostty.enableZshIntegration

Whether to enable Zsh integration.

This ensures that shell integration works in more scenarios, such as switching shells within Ghostty. But it is not needed to have shell integration.

See https://ghostty.org/docs/features/shell-integration#manual-shell-integration-setup for more information.

Type: boolean

Default:

Example:

false

Declared by:

programs.ghostty.package

The ghostty package to use. Set programs.ghostty.package to null on platforms where ghostty is not available or marked broken

Type: null or package

Default:

pkgs.ghostty

Declared by:

programs.ghostty.clearDefaultKeybinds

Whether to clear default keybinds.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.ghostty.installBatSyntax

Whether to enable installation of Ghostty configuration syntax for bat.

Type: boolean

Default: true if programs.ghostty.package is not null

Example:

true

Declared by:

programs.ghostty.installVimSyntax

Whether to enable installation of Ghostty configuration syntax for Vim.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.ghostty.settings

Configuration written to $XDG_CONFIG_HOME/ghostty/config.

See https://ghostty.org/docs/config/reference for more information.

Type: attribute set of (atom (null, bool, int, float or string) or a list of them for duplicate keys)

Default:

{ }

Example:

{
  font-size = 10;
  keybind = [
    "ctrl+h=goto_split:left"
    "ctrl+l=goto_split:right"
  ];
  theme = "catppuccin-mocha";
}

Declared by:

programs.ghostty.systemd

Configuration for Ghostty’s systemd integration. This enables additional speed and features.

See https://ghostty.org/docs/linux/systemd for more information.

Type: submodule

Default:

{ }

Declared by:

programs.ghostty.systemd.enable

Whether to enable the Ghostty systemd user service.

Type: boolean

Default: true on Linux, false otherwise

Example:

true

Declared by:

programs.ghostty.themes

Custom themes written to $XDG_CONFIG_HOME/ghostty/themes.

See https://ghostty.org/docs/features/theme#authoring-a-custom-theme for more information.

Type: attribute set of attribute set of (atom (null, bool, int, float or string) or a list of them for duplicate keys)

Default:

{ }

Example:

{
  catppuccin-mocha = {
    background = "1e1e2e";
    cursor-color = "f5e0dc";
    foreground = "cdd6f4";
    palette = [
      "0=#45475a"
      "1=#f38ba8"
      "2=#a6e3a1"
      "3=#f9e2af"
      "4=#89b4fa"
      "5=#f5c2e7"
      "6=#94e2d5"
      "7=#bac2de"
      "8=#585b70"
      "9=#f38ba8"
      "10=#a6e3a1"
      "11=#f9e2af"
      "12=#89b4fa"
      "13=#f5c2e7"
      "14=#94e2d5"
      "15=#a6adc8"
    ];
    selection-background = "353749";
    selection-foreground = "cdd6f4";
  };
}

Declared by: