mirror of
https://github.com/JanDeDobbeleer/oh-my-posh.git
synced 2024-11-10 13:04:04 -08:00
60 lines
1.8 KiB
Plaintext
60 lines
1.8 KiB
Plaintext
---
|
|
id: winreg
|
|
title: Windows Registry Key Query
|
|
sidebar_label: Windows Registry Key Query
|
|
---
|
|
|
|
## What
|
|
|
|
Display the content of the requested Windows registry key.
|
|
|
|
Supported registry key types:
|
|
|
|
- `SZ` (displayed as string value)
|
|
- `EXPAND_SZ` (displayed as string value)
|
|
- `BINARY` (displayed as string value)
|
|
- `DWORD` (displayed in upper-case 0x hex)
|
|
- `QWORD` (displayed in upper-case 0x hex)
|
|
|
|
## Sample Configuration
|
|
|
|
```json
|
|
{
|
|
"type": "winreg",
|
|
"style": "powerline",
|
|
"powerline_symbol": "\uE0B0",
|
|
"foreground": "#ffffff",
|
|
"background": "#444444",
|
|
"template":" \uE62A {{ .Value }}",
|
|
"properties": {
|
|
"path": "HKLM\\software\\microsoft\\windows nt\\currentversion\\buildlab",
|
|
"fallback":"unknown"
|
|
}
|
|
},
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Name | Type | Description |
|
|
| ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `path` | `string` | registry path to the desired key using backslashes and with a valid root HKEY name. Ending path with \ will get the (Default) key from that path |
|
|
| `fallback` | `string` | the value to fall back to if no entry is found |
|
|
|
|
## Template ([info][templates])
|
|
|
|
:::note default template
|
|
|
|
```template
|
|
{{ .Value }}
|
|
```
|
|
|
|
:::
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Description |
|
|
| ------ | -------- | --------------------------------------------------- |
|
|
| .Value | `string` | The result of your query, or fallback if not found. |
|
|
|
|
[templates]: /docs/configuration/templates
|