oh-my-posh/docs/docs/segment-winreg.md
2021-11-25 09:31:18 +01:00

1.2 KiB

id title sidebar_label
winreg Windows Registry Key Query Windows Registry Key Query

What

Display the content of the requested Windows registry key.

Supported registry key types:

  • String
  • DWORD (displayed in upper-case 0x hex)

Sample Configuration

  {
    "type": "winreg",
    "style": "powerline",
    "powerline_symbol": "\uE0B0",
    "foreground": "#ffffff",
    "background": "#444444",
    "properties": {
      "path": "HKLM\\software\\microsoft\\windows nt\\currentversion",
      "key":"buildlab",
      "template":"{{ if .Value }}{{ .Value }}{{ else }}unknown{{ end }}",
      "prefix": " \uE62A "
    }
  },

Properties

  • path: string - registry path to the desired key using backslashes and with a valid root HKEY name.
  • key: string - the key to read from the path location.
  • fallback: string - the value to fall back to if no entry is found
  • template: string - a go text/template template extended with sprig utilizing the properties below.

Template Properties

  • .Value: string - The result of your query