oh-my-posh/website/docs/segments/upgrade.mdx

48 lines
1.1 KiB
Plaintext
Raw Normal View History

2023-05-18 10:42:57 -07:00
---
id: upgrade
title: Upgrade notice
sidebar_label: Upgrade
---
## What
Displays when there's an update available for Oh My Posh.
## Sample Configuration
import Config from "@site/src/components/Config.js";
<Config
data={{
type: "upgrade",
style: "plain",
foreground: "#111111",
background: "#FFD664",
}}
/>
## Properties
| Name | Type | Default | Description |
| --------------- | :---: | :-----: | ------------------------------------------------------------------------------------- |
| `cache_timeout` | `int` | `10080` | in minutes - how long to wait before checking for a new version. Default is one week. |
2023-05-18 10:42:57 -07:00
## Template ([info][templates])
:::note default template
```template
\uf019
```
:::
### Properties
| Name | Type | Description |
| ---------- | -------- | ----------------------------------- |
| `.Current` | `string` | the current version number |
| `.Latest` | `string` | the latest available version number |
2023-05-18 10:42:57 -07:00
[templates]: /docs/configuration/templates