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

44 lines
741 B
Plaintext
Raw Normal View History

2021-03-27 09:04:09 -07:00
---
id: poshgit
title: Posh-Git
2021-03-28 01:33:53 -07:00
sidebar_label: Git (posh-git)
2021-03-27 09:04:09 -07:00
---
## What
Display the [posh-git][posh-git] prompt.
2021-09-01 04:45:33 -07:00
:::caution
This segment only works within Powershell and requires the posh-git module to be installed and imported
as well as `$env:POSH_GIT_ENABLED = $true` added to your `$PROFILE`.
2021-03-27 09:04:09 -07:00
:::
## Sample Configuration
```json
{
"type": "poshgit",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#0077c2"
}
```
2022-02-01 03:10:46 -08:00
## Template ([info][templates])
:::note default template
``` template
{{ .Status }}
```
:::
### Properties
2022-01-22 10:46:56 -08:00
- `.Status`: `string` - the status reported from posh-git
2021-03-27 09:04:09 -07:00
[posh-git]: https://github.com/dahlbyk/posh-git
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates