Termy

Configuration

Configure Termy settings and appearance


title: Configuration description: Configure Termy settings and appearance order: 2 category: Getting Started

This file is generated by cargo run -p xtask -- generate-config-doc. Do not edit manually.

Termy reads configuration from ~/.config/termy/config.txt.

Appearance

theme

  • Default: termy
  • Current color scheme name
  • Group: THEME

font_family

  • Default: JetBrains Mono
  • Font family used in terminal UI
  • Group: FONT

font_size

  • Default: 14
  • Terminal font size in pixels
  • Group: FONT

background_opacity

  • Default: 1
  • Window background opacity (0.0 to 1.0)
  • Group: WINDOW

background_blur

  • Default: false
  • Enable blur effect for transparent backgrounds
  • Group: WINDOW

padding_x

  • Default: 12
  • Left and right terminal padding
  • Group: PADDING

padding_y

  • Default: 8
  • Top and bottom terminal padding
  • Group: PADDING

Terminal

shell

  • Default: unset
  • Executable used for new sessions
  • Group: SHELL

term

  • Default: xterm-256color
  • TERM value exposed to child applications
  • Group: SHELL

colorterm

  • Default: truecolor
  • COLORTERM value exposed to child applications
  • Group: SHELL

cursor_style

  • Default: block
  • Shape of the terminal cursor
  • Group: CURSOR

cursor_blink

  • Default: true
  • Enable blinking cursor animation
  • Group: CURSOR

mouse_scroll_multiplier

  • Default: 3
  • Mouse wheel scroll speed multiplier
  • Group: SCROLLING

scrollbar_visibility

  • Default: on_scroll
  • Terminal scrollbar visibility behavior
  • Group: SCROLLING

scrollbar_style

  • Default: neutral
  • Terminal scrollbar color style
  • Group: SCROLLING

scrollback_history

  • Default: 2000
  • Aliases: scrollback
  • Lines retained in terminal scrollback
  • Group: SCROLLING

inactive_tab_scrollback

  • Default: unset
  • Scrollback limit for inactive tabs
  • Group: SCROLLING

command_palette_show_keybinds

  • Default: true
  • Show shortcut badges in command palette rows
  • Group: UI

Tabs

tab_title_priority

  • Default: manual, explicit, shell, fallback
  • Exact source priority for tab titles
  • Group: TAB TITLES

tab_title_mode

  • Default: smart
  • How tab titles are determined
  • Group: TAB TITLES

tab_title_fallback

  • Default: Terminal
  • Default tab title when no source is available
  • Group: TAB TITLES

tab_title_explicit_prefix

  • Default: termy:tab:
  • Prefix used for explicit OSC title payloads
  • Group: TAB TITLES

tab_title_shell_integration

  • Default: true
  • Export TERMY_* environment values for shell hooks
  • Group: TAB TITLES

tab_title_prompt_format

  • Default: {cwd}
  • Template for prompt-derived tab titles
  • Group: TAB TITLES

tab_title_command_format

  • Default: {command}
  • Template for command-derived tab titles
  • Group: TAB TITLES

tab_close_visibility

  • Default: active_hover
  • When tab close buttons are visible
  • Group: TAB STRIP

tab_width_mode

  • Default: active_grow_sticky
  • How tab widths react to active state
  • Group: TAB STRIP

show_termy_in_titlebar

  • Default: true
  • Show or hide the termy branding in the titlebar
  • Group: TITLE BAR

Advanced

working_dir

  • Default: unset
  • Initial directory for new sessions
  • Group: STARTUP

working_dir_fallback

  • Default: home (macOS/Windows), process (Linux/other)
  • Aliases: default_working_dir
  • Directory used when working_dir is unset
  • Group: STARTUP

warn_on_quit

  • Default: false
  • Warn every time you try to quit the app
  • Group: SAFETY

warn_on_quit_with_running_process

  • Default: true
  • Warn before quitting when a tab has an active process
  • Group: SAFETY

window_width

  • Default: 1280
  • Default startup window width in pixels
  • Group: WINDOW

window_height

  • Default: 820
  • Default startup window height in pixels
  • Group: WINDOW

Keybindings

keybind

  • Default: built-in platform defaults
  • Keybinding override directive
  • Group: KEYBINDS

Colors

Use [colors] to override theme colors with #RRGGBB values.

foreground

  • Aliases: fg
  • Default text color

background

  • Aliases: bg
  • Terminal background color

cursor

  • Cursor color

black

  • Aliases: color0
  • ANSI black

red

  • Aliases: color1
  • ANSI red

green

  • Aliases: color2
  • ANSI green

yellow

  • Aliases: color3
  • ANSI yellow

blue

  • Aliases: color4
  • ANSI blue

magenta

  • Aliases: color5
  • ANSI magenta

cyan

  • Aliases: color6
  • ANSI cyan

white

  • Aliases: color7
  • ANSI white

bright_black

  • Aliases: brightblack, color8
  • ANSI bright black

bright_red

  • Aliases: brightred, color9
  • ANSI bright red

bright_green

  • Aliases: brightgreen, color10
  • ANSI bright green

bright_yellow

  • Aliases: brightyellow, color11
  • ANSI bright yellow

bright_blue

  • Aliases: brightblue, color12
  • ANSI bright blue

bright_magenta

  • Aliases: brightmagenta, color13
  • ANSI bright magenta

bright_cyan

  • Aliases: brightcyan, color14
  • ANSI bright cyan

bright_white

  • Aliases: brightwhite, color15
  • ANSI bright white