Reference

This is a reference of the Wintty configuration options. These options are ordered roughly by how common they are to be used and grouped with related options. I recommend utilizing your browser's search functionality to find the option you're looking for.

Options Wintty cannot act on, including the macOS-only and Linux/GTK-only ones, are omitted. Options unique to this build are listed under Windows-Only Options.

In the future, we'll have a more user-friendly way to view and organize these options.

The font families to use.

You can generate the list of valid values using the CLI:

wintty +list-fonts

This configuration can be repeated multiple times to specify preferred fallback fonts when the requested codepoint is not available in the primary font. This is particularly useful for multiple languages, symbolic fonts, etc.

Notes on emoji specifically: On macOS, Wintty by default will always use Apple Color Emoji and on Linux will always use Noto Emoji. You can override this behavior by specifying a font family here that contains emoji glyphs.

The specific styles (bold, italic, bold italic) do not need to be explicitly set. If a style is not set, then the regular style (font-family) will be searched for stylistic variants. If a stylistic variant is not found, Wintty will use the regular style. This prevents falling back to a different font family just to get a style such as bold. This also applies if you explicitly specify a font family for a style. For example, if you set font-family-bold = FooBar and "FooBar" cannot be found, Wintty will use whatever font is set for font-family for the bold style.

Finally, some styles may be synthesized if they are not supported. For example, if a font does not have an italic style and no alternative italic font is specified, Wintty will synthesize an italic style by applying a slant to the regular style. If you want to disable these synthesized styles then you can use the font-style configurations as documented below.

You can disable styles completely by using the font-style set of configurations. See the documentation for font-style for more information.

If you want to overwrite a previous set value rather than append a fallback, specify the value as "" (empty string) to reset the list and then set the new values. For example:

font-family = ""
font-family = "My Favorite Font"

Setting any of these as CLI arguments will automatically clear the values set in configuration files so you don't need to specify --font-family="" before setting a new value. You only need to specify this within config files if you want to clear previously set values in configuration files or on the CLI if you want to clear values set on the CLI.

The named font style to use for each of the requested terminal font styles. This looks up the style based on the font style string advertised by the font itself. For example, "Iosevka Heavy" has a style of "Heavy".

You can also use these fields to completely disable a font style. If you set the value of the configuration below to literal false then that font style will be disabled. If the running program in the terminal requests a disabled font style, the regular font style will be used instead.

These are only valid if its corresponding font-family is also specified. If no font-family is specified, then the font-style is ignored unless you're disabling the font style.

Control whether Wintty should synthesize a style if the requested style is not available in the specified font-family.

Wintty can synthesize bold, italic, and bold italic styles if the font does not have a specific style. For bold, this is done by drawing an outline around the glyph of varying thickness. For italic, this is done by applying a slant to the glyph. For bold italic, both of these are applied.

Synthetic styles are not perfect and will generally not look as good as a font that has the style natively. However, they are useful to provide styled text when the font does not have the style.

Set this to "false" or "true" to disable or enable synthetic styles completely. You can disable specific styles using "no-bold", "no-italic", and "no-bold-italic". You can disable multiple styles by separating them with a comma. For example, "no-bold,no-italic".

Available style keys are: bold, italic, bold-italic.

If synthetic styles are disabled, then the regular style will be used instead if the requested style is not available. If the font has the requested style, then the font will be used as-is since the style is not synthetic.

Warning

An easy mistake is to disable bold or italic but not bold-italic. Disabling only bold or italic will NOT disable either in the bold-italic style. If you want to disable bold-italic, you must explicitly disable it. You cannot partially disable bold-italic.

By default, synthetic styles are enabled.

Apply a font feature. To enable multiple font features you can repeat this multiple times or use a comma-separated list of feature settings.

The syntax for feature settings is as follows, where feat is a feature:

• Enable features with e.g. feat, +feat, feat on, feat=1.
• Disabled features with e.g. -feat, feat off, feat=0.
• Set a feature value with e.g. feat=2, feat = 3, feat 4.
• Feature names may be wrapped in quotes, meaning this config should be syntactically compatible with the font-feature-settings CSS property.

The syntax is fairly loose, but invalid settings will be silently ignored.

The font feature will apply to all fonts rendered by Wintty. A future enhancement will allow targeting specific faces.

To disable programming ligatures, use -calt since this is the typical feature name for programming ligatures. To look into what font features your font has and what they do, use a font inspection tool such as fontdrop.info.

To generally disable most ligatures, use -calt, -liga, -dlig.

Font size in points. This value can be a non-integer and the nearest integer pixel size will be selected. If you have a high dpi display where 1pt = 2px then you can get an odd numbered pixel size by specifying a half point.

For example, 13.5pt @ 2px/pt = 27px

Changing this configuration at runtime will only affect existing terminals that have NOT manually adjusted their font size in some way (e.g. increased or decreased the font size). Terminals that have manually adjusted their font size will retain their manually adjusted size. Otherwise, the font size of existing terminals will be updated on reload.

On Linux with GTK, font size is scaled according to both display-wide and text-specific scaling factors, which are often managed by your desktop environment (e.g. the GNOME display scale and large text settings).

A repeatable configuration to set one or more font variations values for a variable font. A variable font is a single font, usually with a filename ending in -VF.ttf or -VF.otf that contains one or more configurable axes for things such as weight, slant, etc. Not all fonts support variations; only fonts that explicitly state they are variable fonts will work.

The format of this is id=value where id is the axis identifier. An axis identifier is always a 4 character string, such as wght. To get the list of supported axes, look at your font documentation or use a font inspection tool.

Invalid ids and values are usually ignored. For example, if a font only supports weights from 100 to 700, setting wght=800 will do nothing (it will not be clamped to 700). You must consult your font's documentation to see what values are supported.

Common axes are: wght (weight), slnt (slant), ital (italic), opsz (optical size), wdth (width), GRAD (gradient), etc.

Force one or a range of Unicode codepoints to map to a specific named font. This is useful if you want to support special symbols or if you want to use specific glyphs that render better for your specific font.

The syntax is codepoint=fontname where codepoint is either a single codepoint or a range. Codepoints must be specified as full Unicode hex values, such as U+ABCD. Codepoints ranges are specified as U+ABCD-U+DEFG. You can specify multiple ranges for the same font separated by commas, such as U+ABCD-U+DEFG,U+1234-U+5678=fontname. The font name is the same value as you would use for font-family.

This configuration can be repeated multiple times to specify multiple codepoint mappings.

Changing this configuration at runtime will only affect new terminals, i.e. new windows, tabs, etc.

Map specific Unicode codepoints to replacement values when copying text to clipboard.

This configuration allows you to replace specific Unicode characters with other characters or strings when copying terminal content to the clipboard. This is useful for converting special terminal symbols to more compatible characters for pasting into other applications.

The syntax is similar to font-codepoint-map:

• Single codepoint: U+1234=U+ABCD or U+1234=replacement_text
• Codepoint range: U+1234-U+5678=U+ABCD

Examples:

• clipboard-codepoint-map = U+2500=U+002D (box drawing horizontal → hyphen)
• clipboard-codepoint-map = U+2502=U+007C (box drawing vertical → pipe)
• clipboard-codepoint-map = U+03A3=SUM (Greek sigma → "SUM")

This configuration can be repeated multiple times to specify multiple mappings. Later entries take priority over earlier ones for overlapping ranges.

Note

This only applies to text copying operations, not URL copying.

Locations to break font shaping into multiple runs.

A "run" is a contiguous segment of text that is shaped together. "Shaping" is the process of converting text (codepoints) into glyphs (renderable characters). This is how ligatures are formed, among other things. For example, if a coding font turns "!=" into a single glyph, then it must see "!" and "=" next to each other in a single run. When a run is broken, the text is shaped separately. To continue our example, if "!" is at the end of one run and "=" is at the start of the next run, then the ligature will not be formed.

Wintty breaks runs at certain points to improve readability or usability. For example, Wintty by default will break runs under the cursor so that text editing can see the individual characters rather than a ligature. This configuration lets you configure this behavior.

Combine values with a comma to set multiple options. Prefix an option with "no-" to disable it. Enabling and disabling options can be done at the same time.

Available options:

• cursor - Break runs under the cursor.

Available since: 1.2.0

What color space to use when performing alpha blending.

This affects the appearance of text and of any images with transparency. Additionally, custom shaders will receive colors in the configured space.

On macOS the default is native, on all other platforms the default is linear-corrected.

Valid values:

• native - Perform alpha blending in the native color space for the OS. On macOS this corresponds to Display P3, and on Linux it's sRGB.

• linear - Perform alpha blending in linear space. This will eliminate the darkening artifacts around the edges of text that are very visible when certain color combinations are used (e.g. red / green), but makes dark text look much thinner than normal and light text much thicker. This is also sometimes known as "gamma correction".

• linear-corrected - Same as linear, but with a correction step applied for text that makes it look nearly or completely identical to native, but without any of the darkening artifacts.

Available since: 1.1.0

All of the configurations behavior adjust various metrics determined by the font. The values can be integers (1, -1, etc.) or a percentage (20%, -15%, etc.). In each case, the values represent the amount to change the original value.

For example, a value of 1 increases the value by 1; it does not set it to literally 1. A value of 20% increases the value by 20%. And so on.

There is little to no validation on these values so the wrong values (e.g. -100%) can cause the terminal to be unusable. Use with caution and reason.

Some values are clamped to minimum or maximum values. This can make it appear that certain values are ignored. For example, many *-thickness adjustments cannot go below 1px.

adjust-cell-height has some additional behaviors to describe:

• The font will be centered vertically in the cell.

• The cursor will remain the same size as the font, but may be adjusted separately with adjust-cursor-height.

• Powerline glyphs will be adjusted along with the cell height so that things like status lines continue to look aligned.

Distance in pixels or percentage adjustment from the bottom of the cell to the text baseline. Increase to move baseline UP, decrease to move baseline DOWN. See the notes about adjustments in adjust-cell-width.

Distance in pixels or percentage adjustment from the top of the cell to the top of the underline. Increase to move underline DOWN, decrease to move underline UP. See the notes about adjustments in adjust-cell-width.

Thickness in pixels of the underline. See the notes about adjustments in adjust-cell-width.

Distance in pixels or percentage adjustment from the top of the cell to the top of the strikethrough. Increase to move strikethrough DOWN, decrease to move strikethrough UP. See the notes about adjustments in adjust-cell-width.

Thickness in pixels or percentage adjustment of the strikethrough. See the notes about adjustments in adjust-cell-width.

Distance in pixels or percentage adjustment from the top of the cell to the top of the overline. Increase to move overline DOWN, decrease to move overline UP. See the notes about adjustments in adjust-cell-width.

Thickness in pixels or percentage adjustment of the overline. See the notes about adjustments in adjust-cell-width.

Thickness in pixels or percentage adjustment of the bar cursor and outlined rect cursor. See the notes about adjustments in adjust-cell-width.

Height in pixels or percentage adjustment of the cursor. Currently applies to all cursor types: bar, rect, and outlined rect. See the notes about adjustments in adjust-cell-width.

Thickness in pixels or percentage adjustment of box drawing characters. See the notes about adjustments in adjust-cell-width.

Height in pixels or percentage adjustment of maximum height for nerd font icons.

A positive (negative) value will increase (decrease) the maximum icon height. This may not affect all icons equally: the effect depends on whether the default size of the icon is height-constrained, which in turn depends on the aspect ratio of both the icon and your primary font.

Certain icons designed for box drawing and terminal graphics, such as Powerline symbols, are not affected by this option.

See the notes about adjustments in adjust-cell-width.

Available in: 1.2.0

The method to use for calculating the cell width of a grapheme cluster. The default value is unicode which uses the Unicode standard to determine grapheme width. This results in correct grapheme width but may result in cursor-desync issues with some programs (such as shells) that may use a legacy method such as wcswidth.

Valid values are:

• legacy - Use a legacy method to determine grapheme width, such as wcswidth This maximizes compatibility with legacy programs but may result in incorrect grapheme width for certain graphemes such as skin-tone emoji, non-English characters, etc.

  This is called "legacy" and not something more specific because the behavior is undefined and we want to retain the ability to modify it. For example, we may or may not use libc wcswidth now or in the future.

• unicode - Use the Unicode standard to determine grapheme width.

If a running program explicitly enables terminal mode 2027, then unicode width will be forced regardless of this configuration. When mode 2027 is reset, this configuration will be used again.

This configuration can be changed at runtime but will not affect existing terminals. Only new terminals will use the new configuration.

FreeType load flags to enable. The format of this is a list of flags to enable separated by commas. If you prefix a flag with no- then it is disabled. If you omit a flag, its default value is used, so you must explicitly disable flags you don't want. You can also use true or false to turn all flags on or off.

This configuration only applies to Wintty builds that use FreeType. This is usually the case for Linux builds and Windows builds using the directwrite_freetype backend. macOS uses CoreText and does not have an equivalent configuration.

Available flags:

• hinting - Enable or disable hinting. Enabled by default.

• force-autohint - Always use the freetype auto-hinter instead of the font's native hinter. Disabled by default.

• monochrome - Instructs renderer to use 1-bit monochrome rendering. This will disable anti-aliasing, and probably not look very good unless you're using a pixel font. Disabled by default.

• autohint - Enable the freetype auto-hinter. Enabled by default.

• light - Use a light hinting style, better preserving glyph shapes. This is the most common setting in GTK apps and therefore also Wintty's default. This has no effect if monochrome is enabled. Enabled by default.

Example: hinting, no-hinting, force-autohint, no-force-autohint

A theme to use. This can be a built-in theme name, a custom theme name, or an absolute path to a custom theme file. Wintty also supports specifying a different theme to use for light and dark mode. Each option is documented below.

If the theme is an absolute pathname, Wintty will attempt to load that file as a theme. If that file does not exist or is inaccessible, an error will be logged and no other directories will be searched.

If the theme is not an absolute pathname, two different directories will be searched for a file name that matches the theme. This is case sensitive on systems with case-sensitive filesystems. It is an error for a theme name to include path separators unless it is an absolute pathname.

The first directory is the themes subdirectory of your Wintty configuration directory. This is $XDG_CONFIG_HOME/wintty/themes or ~/.config/wintty/themes.

The second directory is the themes subdirectory of the Wintty resources directory. Wintty ships with a multitude of themes that will be installed into this directory. On macOS, this list is in the Wintty.app/Contents/Resources/wintty/themes directory. On Linux, this list is in the share/ghostty/themes directory (wherever you installed the Wintty "share" directory.

To see a list of available themes, run wintty +list-themes.

A theme file is simply another Wintty configuration file. They share the same syntax and same configuration options. A theme can set any valid configuration option so please do not use a theme file from an untrusted source. The built-in themes are audited to only set safe configuration options.

Some options cannot be set within theme files. The reason these are not supported should be self-evident. A theme file cannot set theme or config-file. At the time of writing this, Wintty will not show any warnings or errors if you set these options in a theme file but they will be silently ignored.

Any additional colors specified via background, foreground, palette, etc. will override the colors specified in the theme.

To specify a different theme for light and dark mode, use the following syntax: light:theme-name,dark:theme-name. For example: light:Rose Pine Dawn,dark:Rose Pine. Whitespace around all values are trimmed and order of light and dark does not matter. Both light and dark must be specified in this form. In this form, the theme used will be based on the current desktop environment theme.

There are some known bugs with light/dark mode theming. These will be fixed in a future update:

• macOS: titlebar tabs style is not updated when switching themes.

Background color for the window. Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color.

Foreground color for the window. Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color.

Background image for the terminal.

This should be a path to a PNG or JPEG file, other image formats are not yet supported.

The background image is currently per-terminal, not per-window. If you are a heavy split user, the background image will be repeated across splits. A future improvement to Wintty will address this.

Warning

Background images are currently duplicated in VRAM per-terminal. For sufficiently large images, this could lead to a large increase in memory usage (specifically VRAM usage). A future Wintty improvement will resolve this by sharing image textures across terminals.

Available since: 1.2.0

Background image opacity.

This is relative to the value of background-opacity.

A value of 1.0 (the default) will result in the background image being placed on top of the general background color, and then the combined result will be adjusted to the opacity specified by background-opacity.

A value less than 1.0 will result in the background image being mixed with the general background color before the combined result is adjusted to the configured background-opacity.

A value greater than 1.0 will result in the background image having a higher opacity than the general background color. For instance, if the configured background-opacity is 0.5 and background-image-opacity is set to 1.5, then the final opacity of the background image will be 0.5 * 1.5 = 0.75.

Available since: 1.2.0

Background image position.

Valid values are:

• top-left
• top-center
• top-right
• center-left
• center
• center-right
• bottom-left
• bottom-center
• bottom-right

The default value is center.

Available since: 1.2.0

Background image fit.

Valid values are:

• contain

  Preserving the aspect ratio, scale the background image to the largest size that can still be contained within the terminal, so that the whole image is visible.

• cover

  Preserving the aspect ratio, scale the background image to the smallest size that can completely cover the terminal. This may result in one or more edges of the image being clipped by the edge of the terminal.

• stretch

  Stretch the background image to the full size of the terminal, without preserving the aspect ratio.

• none

  Don't scale the background image.

The default value is contain.

Available since: 1.2.0

Whether to repeat the background image or not.

If this is set to true, the background image will be repeated if there would otherwise be blank space around it because it doesn't completely fill the terminal area.

The default value is false.

Available since: 1.2.0

The foreground and background color for selection. If this is not set, then the selection color is just the inverted window background and foreground (note: not to be confused with the cell bg/fg). Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color. Since version 1.2.0, this can also be set to cell-foreground to match the cell foreground color, or cell-background to match the cell background color.

Whether to clear selected text when typing. This defaults to true. This is typical behavior for most terminal emulators as well as text input fields. If you set this to false, then the selected text will not be cleared when typing.

"Typing" is specifically defined as any non-modifier (shift, control, alt, etc.) keypress that produces data to be sent to the application running within the terminal (e.g. the shell). Additionally, selection is cleared when any preedit or composition state is started (e.g. when typing languages such as Japanese).

If this is false, then the selection can still be manually cleared by clicking once or by pressing escape.

Available since: 1.2.0

Whether to clear selected text after copying. This defaults to false.

When set to true, the selection will be automatically cleared after any copy operation that invokes the copy_to_clipboard keyboard binding. Importantly, this will not clear the selection if the copy operation was invoked via copy-on-select.

When set to false, the selection remains visible after copying, allowing to see what was copied and potentially perform additional operations on the same selection.

Characters that mark word boundaries during text selection operations such as double-clicking. When selecting a word, the selection will stop at any of these characters.

This is similar to the WORDCHARS environment variable in zsh, except this specifies the boundary characters rather than the word characters. The default includes common delimiters and punctuation that typically separate words in code and prose.

Each character in this string becomes a word boundary. Multi-byte UTF-8 characters are supported, but only single codepoints can be specified. Multi-codepoint sequences (e.g. emoji) are not supported.

The null character (U+0000) is always treated as a boundary and does not need to be included in this configuration.

Default: \t '"│`|:;,()[]{}<>$

To add or remove specific characters, you can set this to a custom value. For example, to treat semicolons as part of words:

selection-word-chars = "\t '\"│`|:,()[]{}<>$"

Available since: 1.3.0

The minimum contrast ratio between the foreground and background colors. The contrast ratio is a value between 1 and 21. A value of 1 allows for no contrast (e.g. black on black). This value is the contrast ratio as defined by the WCAG 2.0 specification.

If you want to avoid invisible text (same color as background), a value of 1.1 is a good value. If you want to avoid text that is difficult to read, a value of 3 or higher is a good value. The higher the value, the more likely that text will become black or white.

This value does not apply to Emoji or images.

Color palette for the 256 color form that many terminal applications use. The syntax of this configuration is N=COLOR where N is 0 to 255 (for the 256 colors in the terminal color table) and COLOR is a typical RGB color code such as #AABBCC or AABBCC, or a named X11 color. For example, palette = 5=#BB78D9 will set the 'purple' color.

The palette index can be in decimal, binary, octal, or hexadecimal. Decimal is assumed unless a prefix is used: 0b for binary, 0o for octal, and 0x for hexadecimal.

For definitions on the color indices and what they canonically map to, see this cheat sheet.

For most themes, you only need to set the first 16 colors (0–15) since the rest of the palette (16–255) will be automatically generated by default (see palette-generate for more details).

Whether to automatically generate the extended 256 color palette (indices 16–255) from the base 16 ANSI colors.

This lets theme authors specify only the base 16 colors and have the rest of the palette be automatically generated in a consistent and aesthetic way.

When enabled, the 6×6×6 color cube and 24-step grayscale ramp are derived from interpolations of the base palette, giving a more cohesive look. Colors that have been explicitly set via palette are never overwritten.

The default value is false (disabled), because many legacy programs using the 256-color palette hardcode assumptions about what these colors are (mostly assuming the xterm 256 color palette). However, this is still a very useful tool for theme authors and users who want to customize their palette without having to specify all 256 colors.

For more information on how the generation works, see here: https://gist.github.com/jake-stewart/0a8ea46159a7da2c808e5be2177e1783

Available since: 1.3.0

Invert the palette colors generated when palette-generate is enabled, so that the colors go in reverse order. This allows palette-based applications to work well in both light and dark mode since the palettes are always relatively good colors.

This defaults to off because some legacy terminal applications hardcode the assumption that palette indices 16–231 are ordered from darkest to lightest, so enabling this would make them unreadable. This is not a generally good assumption and we encourage modern terminal applications to use the indices in a more semantic way.

This has no effect if palette-generate is disabled.

For more information see palette-generate.

Available since: 1.3.0

The color of the cursor. If this is not set, a default will be chosen.

Direct colors can be specified as either hex (#RRGGBB or RRGGBB) or a named X11 color.

Additionally, special values can be used to set the color to match other colors at runtime:

• cell-foreground - Match the cell foreground color. (Available since: 1.2.0)

• cell-background - Match the cell background color. (Available since: 1.2.0)

The opacity level (opposite of transparency) of the cursor. A value of 1 is fully opaque and a value of 0 is fully transparent. A value less than 0 or greater than 1 will be clamped to the nearest valid value. Note that a sufficiently small value such as 0.3 may be effectively invisible and may make it difficult to find the cursor.

The style of the cursor. This sets the default style. A running program can still request an explicit cursor style using escape sequences (such as CSI q). Shell configurations will often request specific cursor styles.

Note that shell integration will automatically set the cursor to a bar at a prompt, regardless of this configuration. You can disable that behavior by specifying shell-integration-features = no-cursor or disabling shell integration entirely.

Valid values are:

• block
• bar
• underline
• block_hollow

Sets the default blinking state of the cursor. This is just the default state; running programs may override the cursor style using DECSCUSR (CSI q).

If this is not set, the cursor blinks by default. Note that this is not the same as a "true" value, as noted below.

If this is not set at all (null), then Wintty will respect DEC Mode 12 (AT&T cursor blink) as an alternate approach to turning blinking on/off. If this is set to any value other than null, DEC mode 12 will be ignored but DECSCUSR will still be respected.

Valid values are:

• (blank)
• true
• false

The color of the text under the cursor. If this is not set, a default will be chosen. Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color. Since version 1.2.0, this can also be set to cell-foreground to match the cell foreground color, or cell-background to match the cell background color.

Enables the ability to move the cursor at prompts by clicking on a location in the prompt text.

This feature requires prompt marking via OSC 133. Some shells like Fish (v4.1+) and Nu (0.111+) natively support this while others may require additional configuration or Wintty's shell integration features to be enabled.

Depending on the shell, this works either by translating your click position into a series of synthetic arrow key movements or by sending a click event directly to the shell. In either case, some unexpected behavior around edge cases is possible.

Hide the mouse immediately when typing. The mouse becomes visible again when the mouse is used (button, movement, etc.). Platform-specific behavior may dictate other scenarios where the mouse is shown. For example on macOS, the mouse is shown again when a new window, tab, or split is created.

When to scroll the surface to the bottom. The format of this is a list of options to enable separated by commas. If you prefix an option with no- then it is disabled. If you omit an option, its default value is used.

Available options:

• keystroke If set, scroll the surface to the bottom when the user presses a key that results in data being sent to the PTY (basically anything but modifiers or keybinds that are processed by Wintty).

• output If set, scroll the surface to the bottom if there is new data to display (e.g., when new lines are printed to the terminal).

The default is keystroke, no-output.

Determines whether running programs can detect the shift key pressed with a mouse click. Typically, the shift key is used to extend mouse selection.

The default value of false means that the shift key is not sent with the mouse protocol and will extend the selection. This value can be conditionally overridden by the running program with the XTSHIFTESCAPE sequence.

The value true means that the shift key is sent with the mouse protocol but the running program can override this behavior with XTSHIFTESCAPE.

The value never is the same as false but the running program cannot override this behavior with XTSHIFTESCAPE. The value always is the same as true but the running program cannot override this behavior with XTSHIFTESCAPE.

If you always want shift to extend mouse selection even if the program requests otherwise, set this to never.

Valid values are:

• true
• false
• always
• never

Enable or disable mouse reporting. When set to false, mouse events will not be reported to terminal applications even if they request it. This allows you to always use the mouse for selection and other terminal UI interactions without applications capturing mouse input.

When set to true (the default), terminal applications can request mouse reporting and will receive mouse events according to their requested mode.

This can be toggled at runtime using the toggle_mouse_reporting keybind action.

Multiplier for scrolling distance with the mouse wheel.

A prefix of precision: or discrete: can be used to set the multiplier only for scrolling with the specific type of devices. These can be comma-separated to set both types of multipliers at the same time, e.g. precision:0.1,discrete:3. If no prefix is used, the multiplier applies to all scrolling devices. Specifying a prefix was introduced in Wintty 1.2.1.

The value will be clamped to [0.01, 10,000]. Both of these are extreme and you're likely to have a bad experience if you set either extreme.

The default value is "3" for discrete devices and "1" for precision devices.

The opacity level (opposite of transparency) of the background. A value of 1 is fully opaque and a value of 0 is fully transparent. A value less than 0 or greater than 1 will be clamped to the nearest valid value.

On macOS, background opacity is disabled when the terminal enters native fullscreen. This is because the background becomes gray and it can cause widgets to show through which isn't generally desirable.

On macOS, changing this configuration requires restarting Wintty completely.

Applies background opacity to cells with an explicit background color set.

Normally, background-opacity is only applied to the window background. If a cell has an explicit background color set, such as red, then that background color will be fully opaque. An effect of this is that some terminal applications that repaint the background color of the terminal such as a Neovim and Tmux may not respect the background-opacity (by design).

Setting this to true will apply the background-opacity to all cells regardless of whether they have an explicit background color set or not.

Available since: 1.2.0

Whether to blur the background when background-opacity is less than 1.

Valid values are:

• a nonnegative integer specifying the blur intensity
• false, equivalent to a blur intensity of 0
• true, equivalent to the default blur intensity of 20, which is reasonable for a good looking blur. Higher blur intensities may cause strange rendering and performance issues.

On macOS 26.0 and later, there are additional special values that can be set to use the native macOS glass effects:

• macos-glass-regular - Standard glass effect with some opacity
• macos-glass-clear - Highly transparent glass effect

If the macOS values are set, then this implies background-blur = true on non-macOS platforms.

On Linux, the exact blur intensity is ignored and any positive integer or true value will enable background blur. On Wayland, Wintty uses the ext-background-effect-v1 protocol to enable the blur effect, but this is not always supported on all compositors. Check the documentation of your compositor or desktop environment for blur support and how to configure it.

On X11, blur can only be enabled when using the KWin compositor as a part of KDE Plasma.

The opacity level (opposite of transparency) of an unfocused split. Unfocused splits by default are slightly faded out to make it easier to see which split is focused. To disable this feature, set this value to 1.

A value of 1 is fully opaque and a value of 0 is fully transparent. Because "0" is not useful (it makes the window look very weird), the minimum value is 0.15. This value still looks weird but you can at least see what's going on. A value outside of the range 0.15 to 1 will be clamped to the nearest valid value.

The color to dim the unfocused split. Unfocused splits are dimmed by rendering a semi-transparent rectangle over the split. This sets the color of that rectangle and can be used to carefully control the dimming effect.

This will default to the background color.

Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color.

The color of the split divider. If this is not set, a default will be chosen. Specified as either hex (#RRGGBB or RRGGBB) or a named X11 color.

Available since: 1.1.0

Control when Wintty preserves a zoomed split. Under normal circumstances, any operation that changes focus or layout of the split tree in a window will unzoom any zoomed split. This configuration allows you to control this behavior.

This can be set to navigation to preserve the zoomed split state when navigating to another split (e.g. via goto_split). This will change the zoomed split to the newly focused split instead of unzooming.

Any options can also be prefixed with no- to disable that option.

Example: split-preserve-zoom = navigation

Available since: 1.3.0

The foreground and background color for search matches. This only applies to non-focused search matches, also known as candidate matches.

Valid values:

• Hex (#RRGGBB or RRGGBB)
• Named X11 color
• "cell-foreground" to match the cell foreground color
• "cell-background" to match the cell background color

The default value is black text on a golden yellow background.

The foreground and background color for the currently selected search match. This is the focused match that will be jumped to when using next/previous search navigation.

Valid values:

• Hex (#RRGGBB or RRGGBB)
• Named X11 color
• "cell-foreground" to match the cell foreground color
• "cell-background" to match the cell background color

The default value is black text on a soft peach background.

The command to run, usually a shell. If this is not an absolute path, it'll be looked up in the PATH. If this is not set, a default will be looked up from your system. The rules for the default lookup are:

• SHELL environment variable

• passwd entry (user information)

This can contain additional arguments to run the command with. If additional arguments are provided, the command will be executed using /bin/sh -c to offload shell argument expansion.

To avoid shell expansion altogether, prefix the command with direct:, e.g. direct:nvim foo. This will avoid the roundtrip to /bin/sh but will also not support any shell parsing such as arguments with spaces, filepaths with ~, globs, etc. (Available since: 1.2.0)

You can also explicitly prefix the command with shell: to always wrap the command in a shell. This can be used to ensure our heuristics to choose the right mode are not used in case they are wrong. (Available since: 1.2.0)

This command will be used for all new terminal surfaces, i.e. new windows, tabs, etc. If you want to run a command only for the first terminal surface created when Wintty starts, use the initial-command configuration.

Wintty supports the common -e flag for executing a command with arguments. For example, wintty -e fish --with --custom --args. This flag sets the initial-command configuration, see that for more information.

This is the same as "command", but only applies to the first terminal surface created when Wintty starts. Subsequent terminal surfaces will use the command configuration.

After the first terminal surface is created (or closed), there is no way to run this initial command again automatically. As such, setting this at runtime works but will only affect the next terminal surface if it is the first one ever created.

If you're using the wintty CLI there is also a shortcut to set this with arguments directly: you can use the -e flag. For example: wintty -e fish --with --custom --args. The -e flag automatically forces some other behaviors as well:

• Disables shell expansion since the input is expected to already be shell-expanded by the upstream (e.g. the shell used to type in the wintty -e command).

• gtk-single-instance=false - This ensures that a new instance is launched and the CLI args are respected.

• quit-after-last-window-closed=true - This ensures that the Wintty process will exit when the command exits. Additionally, the quit-after-last-window-closed-delay is unset.

• shell-integration=detect (if not none) - This prevents forcibly injecting any configured shell integration into the command's environment. With -e its highly unlikely that you're executing a shell and forced shell integration is likely to cause problems (e.g. by wrapping your command in a shell, setting env vars, etc.). This is a safety measure to prevent unexpected behavior. If you want shell integration with a -e-executed command, you must either name your binary appropriately or source the shell integration script manually.

Controls when command finished notifications are sent. There are three options:

• never - Never send notifications (the default).
• unfocused - Only send notifications if the surface that the command is running in is not focused.
• always - Always send notifications.

Command finished notifications requires that either shell integration is enabled, or that your shell sends OSC 133 escape sequences to mark the start and end of commands.

On GTK, there is a context menu item that will enable command finished notifications for a single command, overriding the never and unfocused options.

Available since 1.3.0.

If command finished notifications are enabled, this controls how the user is notified.

Available options:

• bell - enabled by default
• notify - disabled by default

Options can be combined by listing them as a comma separated list. Options can be negated by prefixing them with no-. For example no-bell,notify.

Available since 1.3.0.

If command finished notifications are enabled, this controls how long a command must have been running before a notification will be sent. The default is five seconds.

The duration is specified as a series of numbers followed by time units. Whitespace is allowed between numbers and units. Each number and unit will be added together to form the total duration.

The allowed time units are as follows:

• y - 365 SI days, or 8760 hours, or 31536000 seconds. No adjustments are made for leap years or leap seconds.
• d - one SI day, or 86400 seconds.
• h - one hour, or 3600 seconds.
• m - one minute, or 60 seconds.
• s - one second.
• ms - one millisecond, or 0.001 second.
• us or µs - one microsecond, or 0.000001 second.
• ns - one nanosecond, or 0.000000001 second.

Examples:

• 1h30m
• 45s

Units can be repeated and will be added together. This means that 1h1h is equivalent to 2h. This is confusing and should be avoided. A future update may disallow this.

The maximum value is 584y 49w 23h 34m 33s 709ms 551µs 615ns. Any value larger than this will be clamped to the maximum value.

Available since 1.3.0

Extra environment variables to pass to commands launched in a terminal surface. The format is env=KEY=VALUE.

env = foo=bar env = bar=baz

Setting env to an empty string will reset the entire map to default (empty).

env =

Setting a key to an empty string will remove that particular key and corresponding value from the map.

env = foo=bar env = foo=

will result in foo not being passed to the launched commands.

Setting a key multiple times will overwrite previous entries.

env = foo=bar env = foo=baz

will result in foo=baz being passed to the launched commands.

These environment variables will override any existing environment variables set by Wintty. For example, if you set GHOSTTY_RESOURCES_DIR then the value you set here will override the value Wintty typically automatically injects.

These environment variables will not be passed to commands run by Wintty for other purposes, like open or xdg-open used to open URLs in your browser.

Available since: 1.2.0

Data to send as input to the command on startup.

The configured command will be launched using the typical rules, then the data specified as this input will be written to the pty before any other input can be provided.

The bytes are sent as-is with no additional encoding. Therefore, be cautious about input that can contain control characters, because this can be used to execute programs in a shell.

The format of this value is:

• raw:<string> - Send raw text as-is. This uses Zig string literal syntax so you can specify control characters and other standard escapes.

• path:<path> - Read a filepath and send the contents. The path must be to a file with finite length. e.g. don't use a device such as /dev/stdin or /dev/urandom as these will block terminal startup indefinitely. Files are limited to 10MB in size to prevent excessive memory usage. If you have files larger than this you should write a script to read the file and send it to the terminal.

If no valid prefix is found, it is assumed to be a raw: input. This is an ergonomic choice to allow you to simply write input = "Hello, world!" (a common case) without needing to prefix every value with raw:.

This can be repeated multiple times to send more data. The data is concatenated directly with no separator characters in between (e.g. no newline).

If any of the input sources do not exist, then none of the input will be sent. Input sources are not verified until the terminal is starting, so missing paths will not show up in config validation.

Changing this configuration at runtime will only affect new terminals.

Available since: 1.2.0

If true, keep the terminal open after the command exits. Normally, the terminal window closes when the running command (such as a shell) exits. With this true, the terminal window will stay open until any keypress is received.

This is primarily useful for scripts or debugging.

The number of milliseconds of runtime below which we consider a process exit to be abnormal. This is used to show an error message when the process exits too quickly.

On Linux, this must be paired with a non-zero exit code. On macOS, we allow any exit code because of the way shell processes are launched via the login command.

The size of the scrollback buffer in bytes. This also includes the active screen. No matter what this is set to, enough memory will always be allocated for the visible screen and anything leftover is the limit for the scrollback.

When this limit is reached, the oldest lines are removed from the scrollback.

Scrollback is stored in memory and allocated lazily up to this limit, so setting a very large limit does not immediately consume that amount of memory. On supported systems with scrollback compression enabled, Wintty attempts to compress fully historical pages which are not currently visible while the terminal is idle. This can reduce physical memory usage, depending on the contents of the scrollback.

This limit always measures the uncompressed logical size of the terminal pages. Compression does not allow Wintty to retain more history than the configured limit. Accessing compressed history restores it transparently and may increase the terminal's physical memory usage again.

This size is per terminal surface, not for the entire application.

A separate maximum can be set with scrollback-limit-lines; if both limits are set, then the first one reached will determine when scrollback is removed.

The default is 50 MB. Set this to unlimited to remove the byte limit.

This can be changed at runtime but will only affect new terminal surfaces.

The maximum number of lines of scrollback to retain. This excludes the active screen. Soft-wrapped lines count as multiple lines.

This limit is an estimate. Internally, Wintty will only trim lines up to the minimum allocation unit that is used internally (called a "page"). The size of a page depends on how many styles, graphemes, etc. take up the screen. In practice, this can be anywhere from a handful to a couple hundred lines. Importantly, memory is capped either way. This means that the actual limited lines will likely be slightly higher in practice.

The default is unlimited. A separate maximum can be set with scrollback-limit-bytes; if both limits are set, then the first one reached will determine when scrollback is removed.

This can be changed at runtime but will only affect new terminal surfaces.

Whether to compress scrollback pages while the terminal is idle.

Wintty does its best to only compress when idle and decompress as needed. This means that compression doesn't lower IO throughput. We recommend you keep it on.

The scrollback limit remains an uncompressed logical limit regardless of this setting, so disabling compression can increase physical memory usage but does not change how much history is retained.

Text-heavy terminal history generally compresses to approximately 10% to 30% of its uncompressed page memory, corresponding to a 70% to 90% reduction in physical memory for pages which are compressed. Compression savings are content-dependent.

Note that the way Wintty works is that we compress and discard the physical/resident memory but we retain virtual mappings. You will not see a decrease in virtual memory usage, but you will see a decrease in physical/memory usage.

Changing this at runtime affects future compression work. Pages which are already compressed remain compressed until their contents are accessed.

Control when the scrollbar is shown to scroll the scrollback buffer.

The default value is system.

Valid values:

• system - Respect the system settings for when to show scrollbars. On macOS, we only show scrollbars while actively scrolling or hovering the gutter. If the system setting is set to "Always", the scrollbar will be shown when the mouse is over the gutter area.

• never - Never show a scrollbar. You can still scroll using the mouse, keybind actions, etc. but you will not have a visual UI widget showing a scrollbar.

Match a regular expression against the terminal text and associate clicking it with an action. This can be used to match URLs, file paths, etc. Actions can be opening using the system opener (e.g. open or xdg-open) or executing any arbitrary binding action.

Links that are configured earlier take precedence over links that are configured later.

A default link that matches a URL and opens it in the system opener always exists. This can be disabled using link-url.

TODO: This can't currently be set!

Enable URL matching. URLs are matched on hover with control (Linux) or command (macOS) pressed and open using the default system application for the linked URL.

The URL matcher is always lowest priority of any configured links (see link). If you want to customize URL matching, use link and disable this.

Enable hyperlinks created with the OSC 8 escape sequence. When disabled, OSC 8 hyperlinks are not highlighted, previewed, copied, or opened.

This does not affect URL matching controlled by link-url.

Available since: 1.4.0

Controls how OSC 8 hyperlinks and the default URL matcher are visually highlighted on screen. This only affects the underline rendering; clicking a link still requires Ctrl (Linux/Windows) or Cmd (macOS) regardless of this setting, so mouse-aware TUI programs (vim with mouse=a, htop, etc.) keep their normal mouse-button semantics.

Available values:

• hover-mods (default): Links are only underlined while the mouse hovers over them with the modifier held. Matches Wintty's minimal-chrome default.

• always: Links are always underlined whenever they appear on screen. Matches the default behavior of most other terminal emulators (Windows Terminal, iTerm2, WezTerm, Kitty, VS Code).

Available since: 1.3.0

Show link previews for a matched URL.

When true, link previews are shown for all matched URLs. When false, link previews are never shown. When set to "osc8", link previews are only shown for hyperlinks created with the OSC 8 sequence (in this case, the link text can differ from the link destination).

Available since: 1.2.0

Whether to start the window in a maximized state. This setting applies to new windows and does not apply to tabs, splits, etc. However, this setting will apply to all new windows, not just the first one.

Available since: 1.1.0

Start new windows in fullscreen. This setting applies to new windows and does not apply to tabs, splits, etc. However, this setting will apply to all new windows, not just the first one.

Allowable values are:

• false - Don't start in fullscreen (default)
• true - Start in native fullscreen
• non-native - (macOS only) Start in non-native fullscreen, hiding the menu bar. This is faster than native fullscreen since it doesn't use animations. On non-macOS platforms, this behaves the same as true.
• non-native-visible-menu - (macOS only) Start in non-native fullscreen, keeping the menu bar visible. On non-macOS platforms, behaves like true.
• non-native-padded-notch - (macOS only) Start in non-native fullscreen, hiding the menu bar but padding for the notch on applicable devices. On non-macOS platforms, behaves like true.

Important: tabs DO NOT WORK with non-native fullscreen modes. Non-native fullscreen removes the titlebar and macOS native tabs require the titlebar. If you use tabs, use true (native) instead.

On macOS, true (native fullscreen) does not work if window-decoration is set to false, because native fullscreen on macOS requires window decorations.

The title Wintty will use for the window. This will force the title of the window to be this title at all times and Wintty will ignore any set title escape sequences programs (such as Neovim) may send.

If you want a blank title, set this to one or more spaces by quoting the value. For example, title = " ". This effectively hides the title. This is necessary because setting a blank value resets the title to the default value of the running program.

This configuration can be reloaded at runtime. If it is set, the title will update for all windows. If it is unset, the next title change escape sequence will be honored but previous changes will not retroactively be set. This latter case may require you to restart programs such as Neovim to get the new title.

The directory to change to after starting the command.

This setting is secondary to the window-inherit-working-directory setting. If a previous Wintty terminal exists in the same process, window-inherit-working-directory will take precedence. Otherwise, this setting will be used. Typically, this setting is used only for the first window.

The default is inherit except in special scenarios listed next. On macOS, if Wintty can detect it is launched from launchd (double-clicked) or open, then it defaults to home. On Linux with GTK, if Wintty can detect it was launched from a desktop launcher, then it defaults to home.

The value of this must be an absolute path, a path prefixed with ~/ (the tilde will be expanded to the user's home directory), or one of the special values below:

• home - The home directory of the executing user.

• inherit - The working directory of the launching process.

Key bindings. The format is trigger=action. Duplicate triggers will overwrite previously set values. The list of actions is available in the documentation or using the wintty +list-actions command.

Trigger: +-separated list of keys and modifiers. Example: ctrl+a, ctrl+shift+b, up.

If the key is a single Unicode codepoint, the trigger will match any presses that produce that codepoint. These are impacted by keyboard layouts. For example, a will match the a key on a QWERTY keyboard, but will match the q key on a AZERTY keyboard (assuming US physical layout).

For Unicode codepoints, matching is done by comparing the set of modifiers with the unmodified codepoint. The unmodified codepoint is sometimes called an "unshifted character" in other software, but all modifiers are considered, not only shift. For example, ctrl+a will match a but not ctrl+shift+a (which is A on a US keyboard).

Further, codepoint matching is case-insensitive and the unmodified codepoint is always case folded for comparison. As a result, ctrl+A configured will match when ctrl+a is pressed. Note that this means some key combinations are impossible depending on keyboard layout. For example, ctrl+_ is impossible on a US keyboard because _ is shift+- and ctrl+shift+- is not equal to ctrl+_ (because the modifiers don't match!). More details on impossible key combinations can be found at this excellent source written by Qt developers: https://doc.qt.io/qt-6/qkeysequence.html#keyboard-layout-issues

Physical key codes can be specified by using any of the key codes as specified by the W3C specification. For example, KeyA will match the physical a key on a US standard keyboard regardless of the keyboard layout. These are case-sensitive.

For aesthetic reasons, the w3c codes also support snake case. For example, key_a is equivalent to KeyA. The only exceptions are function keys, e.g. F1 is f1 (no underscore). This is a consequence of our internal code using snake case but is purposely supported and tested so it is safe to use. It allows an all-lowercase binding which I find more aesthetically pleasing.

Function keys such as insert, up, f5, etc. are also specified using the keys as specified by the previously linked W3C specification.

Physical keys always match with a higher priority than Unicode codepoints, so if you specify both a and KeyA, the physical key will always be used regardless of what order they are configured.

The special key catch_all can be used to match any key that is not otherwise bound. This can be combined with modifiers, for example ctrl+catch_all will match any key pressed with ctrl that is not otherwise bound. When looking up a binding, Wintty first tries to match catch_all with modifiers. If no match is found and the event has modifiers, it falls back to catch_all without modifiers.

Valid modifiers are shift, ctrl (alias: control), alt (alias: opt, option), and super (alias: cmd, command). You may use the modifier or the alias. When debugging keybinds, the non-aliased modifier will always be used in output.

Note

The fn or "globe" key on keyboards are not supported as a modifier. This is a limitation of the operating systems and GUI toolkits that Wintty uses.

Some additional notes for triggers:

• modifiers cannot repeat, ctrl+ctrl+a is invalid.

• modifiers and keys can be in any order, shift+a+ctrl is weird, but valid.

• only a single key input is allowed, ctrl+a+b is invalid.

You may also specify multiple triggers separated by > to require a sequence of triggers to activate the action. For example, ctrl+a>n=new_window will only trigger the new_window action if the user presses ctrl+a followed separately by n. In other software, this is sometimes called a leader key, a key chord, a key table, etc. There is no hardcoded limit on the number of parts in a sequence.

Warning

If you define a sequence as a CLI argument to wintty, you probably have to quote the keybind since > is a special character in most shells. Example: wintty --keybind='ctrl+a>n=new_window'

A trigger sequence has some special handling:

• Wintty will wait an indefinite amount of time for the next key in the sequence. There is no way to specify a timeout. The only way to force the output of a prefix key is to assign another keybind to specifically output that key (e.g. ctrl+a>ctrl+a=text:foo) or press an unbound key which will send both keys to the program.

• If an unbound key is pressed during a sequence and a catch_all binding exists that would ignore the input, the entire sequence is dropped and nothing happens. Otherwise, the entire sequence is encoded and sent to the running program as if no keybind existed.

• If a prefix in a sequence is previously bound, the sequence will override the previous binding. For example, if ctrl+a is bound to new_window and ctrl+a>n is bound to new_tab, pressing ctrl+a will do nothing.

• Adding to the above, if a previously bound sequence prefix is used in a new, non-sequence binding, the entire previously bound sequence will be unbound. For example, if you bind ctrl+a>n and ctrl+a>t, and then bind ctrl+a directly, both ctrl+a>n and ctrl+a>t will become unbound.

• Trigger sequences are not allowed for global: or all:-prefixed triggers. This is a limitation we could remove in the future.

Action is the action to take when the trigger is satisfied. It takes the format action or action:param. The latter form is only valid if the action requires a parameter.

• ignore - Do nothing, ignore the key input. This can be used to black hole certain inputs to have no effect.

• unbind - Remove the binding. This makes it so the previous action is removed, and the key will be sent through to the child command if it is printable. Unbind will remove any matching trigger, including physical:-prefixed triggers without specifying the prefix.

• csi:text - Send a CSI sequence. e.g. csi:A sends "cursor up".

• esc:text - Send an escape sequence. e.g. esc:d deletes to the end of the word to the right.

• text:text - Send a string. Uses Zig string literal syntax. e.g. text:\x15 sends Ctrl-U.

• All other actions can be found in the documentation or by using the wintty +list-actions command.

Some notes for the action:

• The parameter is taken as-is after the :. Double quotes or other mechanisms are included and NOT parsed. If you want to send a string value that includes spaces, wrap the entire trigger/action in double quotes. Example: --keybind="up=csi:A B"

There are some additional special values that can be specified for keybind:

• keybind=clear will clear all set keybindings. Warning: this removes ALL keybindings up to this point, including the default keybindings.

The keybind trigger can be prefixed with some special values to change the behavior of the keybind. These are:

• all:

  Make the keybind apply to all terminal surfaces. By default, keybinds only apply to the focused terminal surface. If this is true, then the keybind will be sent to all terminal surfaces. This only applies to actions that are surface-specific. For actions that are already global (e.g. quit), this prefix has no effect.

  Available since: 1.0.0

• global:

  Make the keybind global. By default, keybinds only work within Wintty and under the right conditions (application focused, sometimes terminal focused, etc.). If you want a keybind to work globally across your system (e.g. even when Wintty is not focused), specify this prefix. This prefix implies all:.

  Note: this does not work in all environments; see the additional notes below for more information.

  Available since: 1.0.0 on macOS, 1.2.0 on GTK

• unconsumed:

  Do not consume the input. By default, a keybind will consume the input, meaning that the associated encoding (if any) will not be sent to the running program in the terminal. If you wish to send the encoded value to the program, specify the unconsumed: prefix before the entire keybind. For example: unconsumed:ctrl+a=reload_config. global: and all:-prefixed keybinds will always consume the input regardless of this setting. Since they are not associated with a specific terminal surface, they're never encoded.

  Available since: 1.0.0

• performable:

  Only consume the input if the action is able to be performed. For example, the copy_to_clipboard action will only consume the input if there is a selection to copy. If there is no selection, Wintty behaves as if the keybind was not set. This has no effect with global: or all:-prefixed keybinds. For key sequences, this will reset the sequence if the action is not performable (acting identically to not having a keybind set at all).

  Performable keybinds will not appear as menu shortcuts in the application menu. This is because the menu shortcuts force the action to be performed regardless of the state of the terminal. Performable keybinds will still work, they just won't appear as a shortcut label in the menu.

  Available since: 1.1.0

Keybind triggers are not unique per prefix combination. For example, ctrl+a and global:ctrl+a are not two separate keybinds. The keybind set later will overwrite the keybind set earlier. In this case, the global: keybind will be used.

Multiple prefixes can be specified. For example, global:unconsumed:ctrl+a=reload_config will make the keybind global and not consume the input to reload the config.

On macOS, this feature requires accessibility permissions to be granted to Wintty. When a global: keybind is specified and Wintty is launched or reloaded, Wintty will attempt to request these permissions. If the permissions are not granted, the keybind will not work. On macOS, you can find these permissions in System Preferences -> Privacy & Security -> Accessibility.

Since Wintty 1.4.0, global shortcuts on Linux are primarily supported through the vicinae-hotkey-v1 protocol, available out-of-the-box with the following Wayland compositors and desktop environments:

• Hyprland since version 0.56.0

On X11 or when your Wayland compositor/desktop environment does not support vicinae-hotkey-v1, the much more widely-used XDG Global Shortcuts protocol is used instead.

Note

XDG Global Shortcuts rely on a functional XDG Desktop Portal implementation that is designed to be used with your desktop environment or compositor. Please make sure that you have the correct one installed.

Desktop environments that are known to support the XDG Global Shortcuts protocol include:

• KDE Plasma since 5.27 with xdg-desktop-portal-kde installed

• GNOME since 48 with xdg-desktop-portal-gnome installed

• Hyprland before version 0.56.0, with xdg-desktop-portal-hyprland installed. Some manual configuration is required. Consult the steps outlined on the Hyprland Wiki to set up D-Bus-based global shortcuts correctly.

Desktop environments and compositors that don't implement either protocol do not support global shortcuts, like wlroots-based compositors e.g. Sway (see upstream issue) and COSMIC.

A keybind can have multiple actions by using the chain keyword for subsequent actions. When a keybind is activated, all chained actions are executed in order. The syntax is:

keybind = ctrl+a=new_window
keybind = chain=goto_split:left

This binds ctrl+a to first open a new window, then move focus to the left split. Each chain entry appends an action to the most recently defined keybind. You can chain as many actions as you want:

keybind = ctrl+a=new_window
keybind = chain=goto_split:left
keybind = chain=toggle_fullscreen

Chained actions cannot have prefixes like global: or unconsumed:. The flags from the original keybind apply to the entire chain.

Chained actions work with key sequences as well. For example:

keybind = ctrl+a>n=new_window
keybind = chain=goto_split:left

Chains with key sequences apply to the most recent binding in the sequence.

Chained keybinds are available since Wintty 1.3.0.

You may also create a named set of keybindings known as a "key table." A key table must be explicitly activated for the bindings to become available. This can be used to implement features such as a "copy mode", "vim mode", etc. Generically, this can implement modal keyboard input.

Key tables are defined using the syntax <table>/<binding>. The <binding> value is everything documented above for keybinds. The <table> value is the name of the key table. Table names can contain anything except /, =, +, and >. The characters + and > are reserved for keybind syntax (modifier combinations and key sequences). For example foo/ctrl+a=new_window defines a binding within a table named foo.

Tables are activated and deactivated using the binding actions activate_key_table:<name> and deactivate_key_table. Other table related binding actions also exist; see the documentation for a full list. These are the primary way to interact with key tables.

Binding lookup proceeds from the innermost table outward, so keybinds in the default table remain available unless explicitly unbound in an inner table.

A key table has some special syntax and handling:

• <name>/ (with no binding) defines and clears a table, resetting all of its keybinds and settings.

• You cannot activate a table that is already the innermost table; such attempts are ignored. However, the same table can appear multiple times in the stack as long as it is not innermost (e.g., A -> B -> A -> B is valid, but A -> B -> B is not).

• A table can be activated in one-shot mode using activate_key_table_once:<name>. A one-shot table is automatically deactivated when any non-catch-all binding is invoked.

• Key sequences work within tables: foo/ctrl+a>ctrl+b=new_window. If an invalid key is pressed, the sequence ends but the table remains active.

• Chain actions work within tables, the chain keyword applies to the most recently defined binding in the table. e.g. if you set table/ctrl+a=new_window you can chain by using chain=text:hello. Important: chain itself doesn't get prefixed with the table name, since it applies to the most recent binding in any table.

• Prefixes like global: work within tables: foo/global:ctrl+a=new_window.

Key tables are available since Wintty 1.3.0.

Remap modifier keys within Wintty. This allows you to swap or reassign modifier keys at the application level without affecting system-wide settings.

The format is from=to where both from and to are modifier key names. You can use generic names like ctrl, alt, shift, super (macOS: cmd/command) or sided names like left_ctrl, right_alt, etc.

This will NOT change keyboard layout or key encodings outside of Wintty. For example, on macOS, option+a may still produce å even if option is remapped to ctrl. Desktop environments usually handle key layout long before Wintty receives the key events.

Example:

key-remap = ctrl=super
key-remap = left_control=right_alt

Important notes:

• This is a one-way remap. If you remap ctrl=super, then the physical Ctrl key acts as Super, but the Super key remains Super.

• Remaps are not transitive. If you remap ctrl=super and alt=ctrl, pressing Alt will produce Ctrl, NOT Super.

• This affects both keybind matching and terminal input encoding. This does NOT impact keyboard layout or how keys are interpreted prior to Wintty receiving them. For example, option+a on macOS may still produce å even if option is remapped to ctrl.

• Generic modifiers (e.g. ctrl) match both left and right physical keys. Use sided names (e.g. left_ctrl) to remap only one side.

There are other edge case scenarios that may not behave as expected but are working as intended the way this feature is designed:

• On macOS, bindings in the main menu will trigger before any remapping is done. This is because macOS itself handles menu activation and this happens before Wintty receives the key event. To workaround this, you should unbind the menu items and rebind them using your desired modifier.

This configuration can be repeated to specify multiple remaps.

Horizontal window padding. This applies padding between the terminal cells and the left and right window borders. The value is in points, meaning that it will be scaled appropriately for screen DPI.

If this value is set too large, the screen will render nothing, because the grid will be completely squished by the padding. It is up to you as the user to pick a reasonable value. If you pick an unreasonable value, a warning will appear in the logs.

Changing this configuration at runtime will only affect new terminals, i.e. new windows, tabs, etc.

To set a different left and right padding, specify two numerical values separated by a comma. For example, window-padding-x = 2,4 will set the left padding to 2 and the right padding to 4. If you want to set both paddings to the same value, you can use a single value. For example, window-padding-x = 2 will set both paddings to 2.

Vertical window padding. This applies padding between the terminal cells and the top and bottom window borders. The value is in points, meaning that it will be scaled appropriately for screen DPI.

If this value is set too large, the screen will render nothing, because the grid will be completely squished by the padding. It is up to you as the user to pick a reasonable value. If you pick an unreasonable value, a warning will appear in the logs.

Changing this configuration at runtime will only affect new terminals, i.e. new windows, tabs, etc.

To set a different top and bottom padding, specify two numerical values separated by a comma. For example, window-padding-y = 2,4 will set the top padding to 2 and the bottom padding to 4. If you want to set both paddings to the same value, you can use a single value. For example, window-padding-y = 2 will set both paddings to 2.

The viewport dimensions are usually not perfectly divisible by the cell size. In this case, some extra padding on the end of a column and the bottom of the final row may exist. If this is true, then this extra padding is automatically balanced between all four edges to minimize imbalance on one side. If this is false, the top left grid cell will always hug the edge with zero padding other than what may be specified with the other window-padding options.

If other window-padding fields are set and this is true, this will still apply. The other padding is applied first and may affect how many grid cells actually exist, and this is applied last in order to balance the padding given a certain viewport size and grid cell size.

Valid values are:

• false - No balancing is applied.
• true - Balance the padding, but cap the top padding to avoid excessive space above the first row. Any excess is shifted to the bottom.
• equal - Balance the padding equally on all sides without any top-padding cap. (Available since: 1.4.0)

The color of the padding area of the window. Valid values are:

• background - The background color specified in background.
• extend - Extend the background color of the nearest grid cell.
• extend-always - Same as "extend" but always extends without applying any of the heuristics that disable extending noted below.

The "extend" value will be disabled in certain scenarios. On primary screen applications (e.g. not something like Neovim), the color will not be extended vertically if any of the following are true:

• The nearest row has any cells that have the default background color. The thinking is that in this case, the default background color looks fine as a padding color.
• The nearest row is a prompt row (requires shell integration). The thinking here is that prompts often contain powerline glyphs that do not look good extended.
• The nearest row contains a perfect fit powerline character. These don't look good extended.

If true, new windows will inherit the working directory of the previously focused window. If no window was previously focused, the default working directory will be used (the working-directory option).

If true, new tabs will inherit the working directory of the previously focused tab. If no tab was previously focused, the default working directory will be used (the working-directory option).

If true, new split panes will inherit the working directory of the previously focused split. If no split was previously focused, the default working directory will be used (the working-directory option).

If true, new windows and tabs will inherit the font size of the previously focused window. If no window was previously focused, the default font size will be used. If this is false, the default font size specified in the configuration font-size will be used.

Configure a preference for window decorations. This setting specifies a preference; the actual OS, desktop environment, window manager, etc. may override this preference. Wintty will do its best to respect this preference but it may not always be possible.

Valid values:

• none

  All window decorations will be disabled. Titlebar, borders, etc. will not be shown. On macOS, this will also disable tabs (enforced by the system).

• auto

  Automatically decide to use either client-side or server-side decorations based on the detected preferences of the current OS and desktop environment. This option usually makes Wintty look the most "native" for your desktop.

• client

  Prefer client-side decorations.

  Available since: 1.1.0

• server

  Prefer server-side decorations. This is only relevant on Linux with GTK, either on X11, or Wayland on a compositor that supports the org_kde_kwin_server_decoration protocol (e.g. KDE Plasma, but almost any non-GNOME desktop supports this protocol).

  If server is set but the environment doesn't support server-side decorations, client-side decorations will be used instead.

  Available since: 1.1.0

The default value is auto.

For the sake of backwards compatibility and convenience, this setting also accepts boolean true and false values. If set to true, this is equivalent to auto. If set to false, this is equivalent to none. This is convenient for users who live primarily on systems that don't differentiate between client and server-side decorations (e.g. macOS and Windows).

The "toggle_window_decorations" keybind action can be used to create a keybinding to toggle this setting at runtime.

macOS: To hide the titlebar without removing the native window borders or rounded corners, use macos-titlebar-style = hidden instead.

The font that will be used for the application's window and tab titles.

If this setting is left unset, the system default font will be used.

Note

any font available on the system may be used, this font is not required to be a fixed-width font.

Available since: 1.0.0 on macOS, 1.1.0 on GTK

The theme to use for the windows. Valid values:

• auto - Determine the theme based on the configured terminal background color. This has no effect if the "theme" configuration has separate light and dark themes. In that case, the behavior of "auto" is equivalent to "system".
• system - Use the system theme.
• light - Use the light theme regardless of system theme.
• dark - Use the dark theme regardless of system theme.
• wintty - Use the background and foreground colors specified in the Wintty configuration. This is only supported on Linux builds.
• ghostty - Deprecated alias for wintty, kept so configurations written for upstream Ghostty keep working. Prefer wintty.

On macOS, if macos-titlebar-style is tabs or transparent, the window theme will be automatically set based on the luminosity of the terminal background color. This only applies to terminal windows. This setting will still apply to non-terminal windows within Wintty.

This is currently only supported on macOS and Linux.

The initial window size. This size is in terminal grid cells by default. Both values must be set to take effect. If only one value is set, it is ignored.

We don't currently support specifying a size in pixels but a future change can enable that. If this isn't specified, the app runtime will determine some default size.

Note that the window manager may put limits on the size or override the size. For example, a tiling window manager may force the window to be a certain size to fit within the grid. There is nothing Wintty will do about this, but it will make an effort.

Sizes larger than the screen size will be clamped to the screen size. This can be used to create a maximized-by-default window size.

This will not affect new tabs, splits, or other nested terminal elements. This only affects the initial window size of any new window. Changing this value will not affect the size of the window after it has been created. This is only used for the initial size.

BUG: On Linux with GTK, the calculated window size will not properly take into account window decorations. As a result, the grid dimensions will not exactly match this configuration. If window decorations are disabled (see window-decoration), then this will work as expected.

Windows smaller than 10 wide by 4 high are not allowed.

Whether to enable saving and restoring window state. Window state includes their position, size, tabs, splits, etc. Some window state requires shell integration, such as preserving working directories. See shell-integration for more information.

There are three valid values for this configuration:

• default will use the default system behavior. On macOS, this will only save state if the application is forcibly terminated or if it is configured systemwide via Settings.app.

• never will never save window state.

• always will always save window state whenever Wintty is exited.

If you change this value to never while Wintty is not running, the next Wintty launch will NOT restore the window state.

If you change this value to default while Wintty is not running and the previous exit saved state, the next Wintty launch will still restore the window state. This is because Wintty cannot know if the previous exit was due to a forced save or not (macOS doesn't provide this information).

If you change this value so that window state is saved while Wintty is not running, the previous window state will not be restored because Wintty only saves state on exit if this is enabled.

The default value is default.

This is currently only supported on macOS. This has no effect on Linux.

The position where new tabs are created. Valid values:

• current - Insert the new tab after the currently focused tab, or at the end if there are no focused tabs.

• end - Insert the new tab at the end of the tab list.

Controls when drag handles are shown over splits, allowing splits to be rearranged with mouse controls.

Valid values:

• always

  Always display the drag handle, even when there's only one split.

• auto (default)

  Automatically show and hide the drag handle.

  On Linux, the handle is only shown when there are two or more splits present.

  On macOS, the handle is only hidden when there's one split in fullscreen mode, otherwise it's shown when hovered.

• never

  Never show the drag handle. Splits then cannot be rearranged with mouse controls.

Available since: 1.4.0.

This controls when resize overlays are shown. Resize overlays are a transient popup that shows the size of the terminal while the surfaces are being resized. The possible options are:

• always - Always show resize overlays.
• never - Never show resize overlays.
• after-first - The resize overlay will not appear when the surface is first created, but will show up if the surface is subsequently resized.

The default is after-first.

If resize overlays are enabled, this controls the position of the overlay. The possible options are:

• center
• top-left
• top-center
• top-right
• bottom-left
• bottom-center
• bottom-right

The default is center.

If resize overlays are enabled, this controls how long the overlay is visible on the screen before it is hidden. The default is ¾ of a second or 750 ms.

The duration is specified as a series of numbers followed by time units. Whitespace is allowed between numbers and units. Each number and unit will be added together to form the total duration.

The allowed time units are as follows:

• y - 365 SI days, or 8760 hours, or 31536000 seconds. No adjustments are made for leap years or leap seconds.
• d - one SI day, or 86400 seconds.
• h - one hour, or 3600 seconds.
• m - one minute, or 60 seconds.
• s - one second.
• ms - one millisecond, or 0.001 second.
• us or µs - one microsecond, or 0.000001 second.
• ns - one nanosecond, or 0.000000001 second.

Examples:

• 1h30m
• 45s

Units can be repeated and will be added together. This means that 1h1h is equivalent to 2h. This is confusing and should be avoided. A future update may disallow this.

The maximum value is 584y 49w 23h 34m 33s 709ms 551µs 615ns. Any value larger than this will be clamped to the maximum value.

Available since 1.0.0

If true, when there are multiple split panes, the mouse selects the pane that is focused. This only applies to the currently focused window; e.g. mousing over a split in an unfocused window will not focus that split and bring the window to front.

Default is false.

Whether to allow programs running in the terminal to read/write to the system clipboard (OSC 52, for googling). The default is to allow clipboard reading after prompting the user and allow writing unconditionally.

Valid values are:

• ask
• allow
• deny

Trims trailing whitespace on data that is copied to the clipboard. This does not affect data sent to the clipboard via clipboard-write. This only applies to trailing whitespace on lines that have other characters. Completely blank lines always have their whitespace trimmed.

Require confirmation before pasting text that appears unsafe. This helps prevent a "copy/paste attack" where a user may accidentally execute unsafe commands by pasting text with newlines.

If true, bracketed pastes will be considered safe. By default, bracketed pastes are considered safe. "Bracketed" pastes are pastes while the running program has bracketed paste mode enabled (a setting set by the running program, not the terminal emulator).

Enables or disabled title reporting (CSI 21 t). This escape sequence allows the running program to query the terminal title. This is a common security issue and is disabled by default.

Warning

This can expose sensitive information at best and enable arbitrary code execution at worst (with a maliciously crafted title and a minor amount of user interaction).

Available since: 1.0.1

The total amount of bytes that can be used for image data (e.g. the Kitty image protocol) per terminal screen. The maximum value is 4,294,967,295 (4GiB). The default is 320MB. If this is set to zero, then all image protocols will be disabled.

This value is separate for primary and alternate screens so the effective limit per surface is double.

The peak GPU upload-heap pressure the renderer will tolerate for image uploads in a single frame. When pending images would push the in-flight total past this value, the renderer defers the overflowing image to a later frame -- the image stays pending and retries once budget clears. The default is 128MB. Setting this to zero disables the budget entirely (every pending image uploads immediately, no matter how many bytes are already in flight).

Currently only effective on the DirectX 12 renderer (Windows). Other renderers ignore this value.

Whether to automatically copy selected text to the clipboard. true will prefer to copy to the selection clipboard, otherwise it will copy to the system clipboard.

The value clipboard will always copy text to the selection clipboard as well as the system clipboard.

Middle-click primary paste (see middle-click-action) is enabled by default even if this is false. The clipboard it pastes from follows this setting: with true (or false) it reads from the selection clipboard (falling back to the system clipboard on platforms without a selection clipboard); with clipboard it reads from the system clipboard.

The default value is true on Linux, macOS, and Windows.

The action to take when the user right-clicks on the terminal surface.

Valid values:

• context-menu - Show the context menu.
• paste - Paste the contents of the clipboard.
• copy - Copy the selected text to the clipboard.
• copy-or-paste - If there is a selection, copy the selected text to the clipboard; otherwise, paste the contents of the clipboard.
• ignore - Do nothing, ignore the right-click.

The default value is context-menu.

The action to take when the user middle-clicks on the terminal surface.

Valid values:

• primary-paste - Paste from the selection (or system) clipboard per copy-on-select.
• ignore - Do nothing, ignore the middle click.

The default value is primary-paste.

The time in milliseconds between clicks to consider a click a repeat (double, triple, etc.) or an entirely new single click. A value of zero will use a platform-specific default. The default on macOS is determined by the OS settings. On every other platform it is 500ms.

Additional configuration files to read. This configuration can be repeated to read multiple configuration files. Configuration files themselves can load more configuration files. Paths are relative to the file containing the config-file directive. For command-line arguments, paths are relative to the current working directory.

Prepend a ? character to the file path to suppress errors if the file does not exist. If you want to include a file that begins with a literal ? character, surround the file path in double quotes (").

Cycles are not allowed. If a cycle is detected, an error will be logged and the configuration file will be ignored.

Configuration files are loaded after the configuration they're defined within in the order they're defined. THIS IS A VERY SUBTLE BUT IMPORTANT POINT. To put it another way: configuration files do not take effect until after the entire configuration is loaded. For example, in the configuration below:

config-file = "foo"
a = 1

If "foo" contains a = 2, the final value of a will be 2, because foo is loaded after the configuration file that configures the nested config-file value.

When this is true, the default configuration file paths will be loaded. The default configuration file paths are currently only the XDG config path ($XDG_CONFIG_HOME/wintty/config.wintty).

If this is false, the default configuration paths will not be loaded. This is targeted directly at using Wintty from the CLI in a way that minimizes external effects.

This is a CLI-only configuration. Setting this in a configuration file will have no effect. It is not an error, but it will not do anything. This configuration can only be set via CLI arguments.

Confirms that a surface should be closed before closing it.

This defaults to true. If set to false, surfaces will close without any confirmation. This can also be set to always, which will always confirm closing a surface, even if shell integration says a process isn't running.

Whether or not to quit after the last surface is closed.

This defaults to false on macOS since that is standard behavior for a macOS application. On Linux, this defaults to true since that is generally expected behavior.

On Linux, if this is true, Wintty can delay quitting fully until a configurable amount of time has passed after the last window is closed. See the documentation of quit-after-last-window-closed-delay.

The duration that undo operations remain available. After this time, the operation will be removed from the undo stack and cannot be undone.

The default value is 5 seconds.

This timeout applies per operation, meaning that if you perform multiple operations, each operation will have its own timeout. New operations do not reset the timeout of previous operations.

A timeout of zero will effectively disable undo operations. It is not possible to set an infinite timeout, but you can set a very large timeout to effectively disable the timeout (on the order of years). This is highly discouraged, as it will cause the undo stack to grow indefinitely, memory usage to grow unbounded, and terminal sessions to never actually quit.

The duration is specified as a series of numbers followed by time units. Whitespace is allowed between numbers and units. Each number and unit will be added together to form the total duration.

The allowed time units are as follows:

• y - 365 SI days, or 8760 hours, or 31536000 seconds. No adjustments are made for leap years or leap seconds.
• d - one SI day, or 86400 seconds.
• h - one hour, or 3600 seconds.
• m - one minute, or 60 seconds.
• s - one second.
• ms - one millisecond, or 0.001 second.
• us or µs - one microsecond, or 0.000001 second.
• ns - one nanosecond, or 0.000000001 second.

Examples:

• 1h30m
• 45s

Units can be repeated and will be added together. This means that 1h1h is equivalent to 2h. This is confusing and should be avoided. A future update may disallow this.

This configuration is only supported on macOS. Linux doesn't support undo operations at all so this configuration has no effect.

Available since: 1.2.0

The position of the "quick" terminal window. To learn more about the quick terminal, see the documentation for the toggle_quick_terminal binding action.

Valid values are:

• top - Terminal appears at the top of the screen.
• bottom - Terminal appears at the bottom of the screen.
• left - Terminal appears at the left of the screen.
• right - Terminal appears at the right of the screen.
• center - Terminal appears at the center of the screen.

On macOS, changing this configuration requires restarting Wintty completely.

Note

There is no default keybind for toggling the quick terminal. To enable this feature, bind the toggle_quick_terminal action to a key.

The size of the quick terminal.

The size can be specified either as a percentage of the screen dimensions (height/width), or as an absolute size in pixels. Percentage values are suffixed with % (e.g. 20%) while pixel values are suffixed with px (e.g. 300px). A bare value without a suffix is a config error.

When only one size is specified, the size parameter affects the size of the quick terminal on its primary axis, which depends on its position: height for quick terminals placed on the top or bottom, and width for left or right. The primary axis of a centered quick terminal depends on the monitor's orientation: height when on a landscape monitor, and width when on a portrait monitor.

The secondary axis would be maximized for non-center positioned quick terminals unless another size parameter is specified, separated from the first by a comma (,). Percentage and pixel sizes can be mixed together: for instance, a size of 50%,500px for a top-positioned quick terminal would be half a screen tall, and 500 pixels wide.

Available since: 1.2.0

The screen where the quick terminal should show up.

Valid values are:

• main - The screen that the operating system recommends as the main screen. On macOS, this is the screen that is currently receiving keyboard input. This screen is defined by the operating system and not chosen by Wintty.

• mouse - The screen that the mouse is currently hovered over.

• macos-menu-bar - The screen that contains the macOS menu bar as set in the display settings on macOS. This is a bit confusing because every screen on macOS has a menu bar, but this is the screen that contains the primary menu bar.

The default value is main because this is the recommended screen by the operating system.

On macOS, macos-menu-bar uses the screen containing the menu bar. On Linux/Wayland, macos-menu-bar is treated as equivalent to main.

Note

On Linux, there is no universal concept of a "primary" monitor. Wintty uses the compositor-reported primary output when available and falls back to the first monitor reported by GDK if no primary output can be resolved.

Duration (in seconds) of the quick terminal enter and exit animation. Set it to 0 to disable animation completely. This can be changed at runtime.

Only implemented on macOS.

Automatically hide the quick terminal when focus shifts to another window. Set it to false for the quick terminal to remain open even when it loses focus.

Defaults to true on macOS and on false on Linux/BSD. This is because global shortcuts on Linux require system configuration and are considerably less accessible than on macOS, meaning that it is more preferable to keep the quick terminal open until the user has completed their task. This default may change in the future.

Whether to enable shell integration auto-injection or not. Shell integration greatly enhances the terminal experience by enabling a number of features:

• Working directory reporting so new tabs, splits inherit the previous terminal's working directory.

• Prompt marking that enables the "jump_to_prompt" keybinding.

• If you're sitting at a prompt, closing a terminal will not ask for confirmation.

• Resizing the window with a complex prompt usually paints much better.

Allowable values are:

• none - Do not do any automatic injection. You can still manually configure your shell to enable the integration.

• detect - Detect the shell based on the filename.

• bash, elvish, fish, nushell, zsh - Use this specific shell injection scheme.

The default value is detect.

Shell integration features to enable. These require our shell integration to be loaded, either automatically via shell-integration or manually.

The format of this is a list of features to enable separated by commas. If you prefix a feature with no- then it is disabled. If you omit a feature, its default value is used, so you must explicitly disable features you don't want. You can also use true or false to turn all features on or off.

Example: cursor, no-cursor, sudo, no-sudo, title, no-title

Available features:

• cursor - Set the cursor to a bar at the prompt.

• sudo - Set sudo wrapper to preserve terminfo.

• title - Set the window title via shell integration.

• ssh-env - Enable SSH environment variable compatibility. Automatically converts TERM from xterm-ghostty to xterm-256color when connecting to remote hosts and propagates COLORTERM, TERM_PROGRAM, and TERM_PROGRAM_VERSION. Whether or not these variables will be accepted by the remote host(s) will depend on whether or not the variables are allowed in their sshd_config. (Available since: 1.2.0)

• ssh-terminfo - Enable automatic terminfo installation on remote hosts. Attempts to install Wintty's terminfo entry using infocmp and tic when connecting to hosts that lack it. Requires infocmp to be available locally and tic to be available on remote hosts. Once terminfo is installed on a remote host, it will be automatically "cached" to avoid repeat installations. If desired, the +ssh-cache CLI action can be used to manage the installation cache manually using various arguments. (Available since: 1.2.0)

• path - Add Wintty's binary directory to PATH. This ensures the wintty command is available in the shell even if shell init scripts reset PATH. This is particularly useful on macOS where PATH is often overridden by system scripts. The directory is only added if not already present.

SSH features work independently and can be combined for optimal experience: when both ssh-env and ssh-terminfo are enabled, Wintty will install its terminfo on remote hosts and use xterm-ghostty as TERM, falling back to xterm-256color with environment variables if terminfo installation fails.

Controls whether Wintty injects a UTF-8 codepage setup into spawned cmd / PowerShell shells on Windows. See the Utf8Console enum for the full description of auto, always, and never. Has no effect on non-Windows platforms.

Custom entries into the command palette.

Each entry requires the title, the corresponding action, and an optional description. Each field should be prefixed with the field name, a colon (:), and then the specified value. The syntax for actions is identical to the one for keybind actions. Whitespace in between fields is ignored.

If you need to embed commas or any other special characters in the values, enclose the value in double quotes and it will be interpreted as a Zig string literal. This is also useful for including whitespace at the beginning or the end of a value. See the Zig documentation for more information on string literals. Note that multiline string literals are not supported.

Double quotes can not be used around the field names.

command-palette-entry = title:Reset Font Style, action:csi:0m
command-palette-entry = title:Crash on Main Thread,description:Causes a crash on the main (UI) thread.,action:crash:main
command-palette-entry = title:Focus Split: Right,description:"Focus the split to the right, if it exists.",action:goto_split:right
command-palette-entry = title:"Wintty",description:"Add a little Wintty to your terminal.",action:"text:\xf0\x9f\x91\xbb"

There are some additional special values that can be specified for command-palette-entry:

• command-palette-entry=clear will clear all command entries. Warning: this removes ALL entries up to this point, including the default entries. Available since: 1.4.0

By default, the command palette is preloaded with most actions that might be useful in an interactive setting yet do not have easily accessible or memorizable shortcuts. The default entries can be restored by setting this setting to an empty value:

command-palette-entry =

Available since: 1.2.0

Sets the reporting format for OSC sequences that request color information. Wintty currently supports OSC 10 (foreground), OSC 11 (background), and OSC 4 (256 color palette) queries, and by default the reported values are scaled-up RGB values, where each component are 16 bits. This is how most terminals report these values. However, some legacy applications may require 8-bit, unscaled, components. We also support turning off reporting altogether. The components are lowercase hex values.

Allowable values are:

• none - OSC 4/10/11 queries receive no reply

• 8-bit - Color components are return unscaled, e.g. rr/gg/bb

• 16-bit - Color components are returned scaled, e.g. rrrr/gggg/bbbb

The default value is 16-bit.

If true, allows the "KAM" mode (ANSI mode 2) to be used within the terminal. KAM disables keyboard input at the request of the application. This is not a common feature and is not recommended to be enabled. This will not be documented further because if you know you need KAM, you know. If you don't know if you need KAM, you don't need it.

Custom shaders to run after the default shaders. This is a file path to a GLSL-syntax shader for all platforms.

Warning

Invalid shaders can cause Wintty to become unusable such as by causing the window to be completely black. If this happens, you can unset this configuration to disable the shader.

Custom shader support is based on and compatible with the Shadertoy shaders. Shaders should specify a mainImage function and the available uniforms largely match Shadertoy, with some caveats and Wintty-specific extensions.

The uniform values available to shaders are as follows:

• sampler2D iChannel0 - Input texture.

  A texture containing the current terminal screen. If multiple custom shaders are specified, the output of previous shaders is written to this texture, to allow combining multiple effects.

• vec3 iResolution - Output texture size, [width, height, 1] (in px).

• float iTime - Time in seconds since first frame was rendered.

• float iTimeDelta - Time in seconds since previous frame was rendered.

• float iFrameRate - Average framerate. (NOT CURRENTLY SUPPORTED)

• int iFrame - Number of frames that have been rendered so far.

• float iChannelTime[4] - Current time for video or sound input. (N/A)

• vec3 iChannelResolution[4] - Resolutions of the 4 input samplers.

  Currently only iChannel0 exists, and iChannelResolution[0] is identical to iResolution.

• vec4 iMouse - Mouse input info. (NOT CURRENTLY SUPPORTED)

• vec4 iDate - Date/time info. (NOT CURRENTLY SUPPORTED)

• float iSampleRate - Sample rate for audio. (N/A)

Wintty-specific extensions:

• vec4 iCurrentCursor - Info about the terminal cursor.

  • iCurrentCursor.xy is the -X, +Y corner of the current cursor.
  • iCurrentCursor.zw is the width and height of the current cursor.

• vec4 iPreviousCursor - Info about the previous terminal cursor.

• vec4 iCurrentCursorColor - Color of the terminal cursor.

• vec4 iPreviousCursorColor - Color of the previous terminal cursor.

• vec4 iCurrentCursorStyle - Style of the terminal cursor

  Macros simplified use are defined for the various cursor styles:

  • CURSORSTYLE_BLOCK or 0
  • CURSORSTYLE_BLOCK_HOLLOW or 1
  • CURSORSTYLE_BAR or 2
  • CURSORSTYLE_UNDERLINE or 3
  • CURSORSTYLE_LOCK or 4

• vec4 iPreviousCursorStyle - Style of the previous terminal cursor

• vec4 iCursorVisible - Visibility of the terminal cursor.

• float iTimeCursorChange - Timestamp of terminal cursor change.

  When the terminal cursor changes position or color, this is set to the same time as the iTime uniform, allowing you to compute the time since the change by subtracting this from iTime.

• float iTimeFocus - Timestamp when the surface last gained iFocus.

  When the surface gains focus, this is set to the current value of iTime, similar to how iTimeCursorChange works. This allows you to compute the time since focus was gained or lost by calculating iTime - iTimeFocus. Use this to create animations that restart when the terminal regains focus.

• int iFocus - Current focus state of the surface.

  Set to 1.0 when the surface is focused, 0.0 when unfocused. This allows shaders to detect unfocused state and avoid animation artifacts from large time deltas caused by infrequent "deceptive frames" (e.g., modifier key presses, link hover events in unfocused split panes). Check iFocus > 0 to determine if the surface is currently focused.

• vec3 iPalette[256] - The 256-color terminal palette.

  RGB values for all 256 colors in the terminal palette, normalized to [0.0, 1.0]. Index 0-15 are the ANSI colors, 16-231 are the 6x6x6 color cube, and 232-255 are the grayscale colors.

• vec3 iBackgroundColor - Terminal background color (RGB).

• vec3 iForegroundColor - Terminal foreground color (RGB).

• vec3 iCursorColor - Terminal cursor color (RGB).

• vec3 iCursorText - Terminal cursor text color (RGB).

• vec3 iSelectionBackgroundColor - Selection background color (RGB).

• vec3 iSelectionForegroundColor - Selection foreground color (RGB).

If the shader fails to compile, the shader will be ignored. Any errors related to shader compilation will not show up as configuration errors and only show up in the log, since shader compilation happens after configuration loading on the dedicated render thread. For interactive development, use shadertoy.com.

This can be repeated multiple times to load multiple shaders. The shaders will be run in the order they are specified.

This can be changed at runtime and will affect all open terminals.

If true (default), the focused terminal surface will run an animation loop when custom shaders are used. This uses slightly more CPU (generally less than 10%) but allows the shader to animate. This only runs if there are custom shaders and the terminal is focused.

If this is set to false, the terminal and custom shader will only render when the terminal is updated. This is more efficient but the shader will not animate.

This can also be set to always, which will always run the animation loop regardless of whether the terminal is focused or not. The animation loop will still only run when custom shaders are used. Note that this will use more CPU per terminal surface and can become quite expensive depending on the shader and your terminal usage.

This can be changed at runtime and will affect all open terminals.

Bell features to enable if bell support is available in your runtime. Not all features are available on all runtimes. The format of this is a list of features to enable separated by commas. If you prefix a feature with no- then it is disabled. If you omit a feature, its default value is used.

Valid values are:

• system

  Instruct the system to notify the user using built-in system functions. This could result in an audiovisual effect, a notification, or something else entirely. Changing these effects require altering system settings: for instance under the "Sound > Alert Sound" setting in GNOME, or the "Accessibility > System Bell" settings in KDE Plasma.

  On macOS, this plays the system alert sound.

• audio

  Play a custom sound. (Available since 1.3.0 on macOS)

• attention (enabled by default)

  Request the user's attention when Wintty is unfocused, until it has received focus again. On macOS, this will bounce the app icon in the dock once. On Linux, the behavior depends on the desktop environment and/or the window manager/compositor:

  • On KDE, the background of the desktop icon in the task bar would be highlighted;

  • On GNOME, you may receive a notification that, when clicked, would bring the Wintty window into focus;

  • On Sway, the window may be decorated with a distinctly colored border;

  • On other systems this may have no effect at all.

• title (enabled by default)

  Prepend a bell emoji (🔔) to the title of the alerted surface until the terminal is re-focused or interacted with (such as on keyboard input).

• border

  Display a border around the alerted surface until the terminal is re-focused or interacted with (such as on keyboard input).

  Available since: 1.2.0 on GTK, 1.2.1 on macOS

Example: audio, no-audio, system, no-system

Available since: 1.2.0

If audio is an enabled bell feature, this is a path to an audio file. If the path is not absolute, it is considered relative to the directory of the configuration file that it is referenced from, or from the current working directory if this is used as a CLI flag. The path may be prefixed with ~/ to reference the user's home directory.

Available since: 1.2.0 on GTK, 1.3.0 on macOS.

If audio is an enabled bell feature, this is the volume to play the audio file at (relative to the system volume). This is a floating point number ranging from 0.0 (silence) to 1.0 (as loud as possible). The default is 0.5.

Available since: 1.2.0 on GTK, 1.3.0 on macOS.

Automatically reload the configuration when the config file changes on disk. Uses a platform-specific file watcher (e.g. FileSystemWatcher on Windows). When false, config is only reloaded via explicit keybind or menu action.

Available since: 1.1.1

Enable the built-in Settings UI on Windows. On other platforms, this option has no effect. When false, the "open config" action opens the config file in the default editor (matching macOS behavior). When true, opens the built-in settings window with structured editing.

Available since: 1.1.1

If true (default), applications running in the terminal can show desktop notifications using certain escape sequences such as OSC 9 or OSC 777.

If true (default), applications running in the terminal can show graphical progress bars using the ConEmu OSC 9;4 escape sequence. If false, progress bar sequences are silently ignored.

Modifies the color used for bold text in the terminal.

This can be set to a specific color, using the same format as background or foreground (e.g. #RRGGBB but other formats are also supported; see the aforementioned documentation). If a specific color is set, this color will always be used for the default bold text color. It will set the rest of the bold colors to bright.

This can also be set to bright, which uses the bright color palette for bold text. For example, if the text is red, then the bold will use the bright red color. The terminal palette is set with palette but can also be overridden by the terminal application itself using escape sequences such as OSC 4. (Since Wintty 1.2.0, the previous configuration bold-is-bright is deprecated and replaced by this usage).

Available since Wintty 1.2.0.

The opacity level (opposite of transparency) of the faint text. A value of 1 is fully opaque and a value of 0 is fully transparent. A value less than 0 or greater than 1 will be clamped to the nearest valid value.

Available since Wintty 1.2.0.

This will be used to set the TERM environment variable. HACK: We set this with an xterm prefix because vim uses that to enable key protocols (specifically this will enable modifyOtherKeys), among other features. An option exists in vim to modify this: :set keyprotocol=wintty:kitty, however a bug in the implementation prevents it from working properly. https://github.com/vim/vim/pull/13211 fixes this.

String to send when we receive ENQ (0x05) from the command that we are running. Defaults to an empty string if not set.