Global Settings

The following top-level global attributes are configurable in config.yml. See this example config file for more details.

wtf:
  colors:
    background: "red"
    border:
      focusable: "darkslateblue"
      focused: "orange"
      normal: "gray"
    checked: "gray"
    highlight:
      fore: "black"
      back: "green"
    text: "white"
    title: "white"
  exitMessage:
    display: true
    githubAPIKey: "d8....................................ea"
  grid:
    # How _wide_ the columns are, in terminal characters. In this case we have
    # six columns, each of which are 35 characters wide
    columns: [35, 35, 35, 35, 35, 35]

    # How _high_ the rows are, in terminal lines. In this case we have five rows
    # that support ten line of text, one of three lines, and one of four
    rows: [10, 10, 10, 10, 10, 3, 4]
  navigation:
    shortcuts: true
  openFileUtil: "open"
  openUrlUtil:
    - "tmux"
    - "new-window"
    - "elinks"
  sigils:
    checkbox:
      checked: "x"
      unchecked: " "
    paging:
      normal: "*"
      selected: "_"
  term: "xterm-256color"

Attributes

Name	Value
`colors.background` The color to draw the background of the app in. Use this to match your terminal colors. May be over-written by individual module configurations.	Any X11 color name.
`colors.border.focusable` The color in which to draw the border of widgets that can accept keyboard focus.	Any X11 color name.
`colors.border.focused` The color in which to draw the border of the widget that currently has keyboard focus.	Any X11 color name.
`colors.border.normal` The color in which to draw the borders of the widgets that cannot accept focus.	Any X11 color name.
`exitMessage.display` Whether or not to display the WTF text message in the terminal when the app exits.	`true`, `false`
`exitMessage.githubAPIKey` The user's GitHub API key. Used to check against the GitHub API to see if the user is a code contributor or sponsor.	Your API key or leave it empty to use the `WTF_GITHUB_TOKEN` environment variable.
`grid.columns` An array that defines the widths of all the columns.	See tview's Grid for details
`grid.rows` An array that defines the heights of all the rows.	See tview's Grid for details
`navigation.shortcuts` Whether or not to display the numeric navigation shortcuts in widget titles.	`true` or `false`
`openFileUtil` Which local utility to use to open a file or URL. Requires the app to be restarted to take effect. Default: `open`.
`opeUrlUtil` A string sequence used to open URL. If undefined, wtfutil will attempt to open it based on the operating system.
`term` Sets a custom value for the terminal type this app runs in. Leave this entry out of the config if you simply want to use your terminal's default setting. Note: If an invalid value is provided for this setting, the app will crash with a `terminal entry not found` error.	Any valid terminal type (ie: `vt100`, `xterm`, `xterm-256color`, `ansi`, etc.).