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

57 lines
1.6 KiB
Plaintext
Raw Normal View History

2022-02-16 08:23:40 -08:00
---
id: cf
title: Cloud Foundry
sidebar_label: Cloud Foundry
---
## What
Display the active [Cloud Foundry CLI][cloud-foundry] version.
## Sample Configuration
```json
{
"background": "#a7cae1",
"foreground": "#100e23",
"powerline_symbol": "\ue0b0",
2022-03-27 01:12:47 -07:00
"template": " \uf40a cf {{ .Full }} ",
2022-02-16 08:23:40 -08:00
"style": "powerline",
"type": "cf"
}
```
## Properties
- home_enabled: `boolean` - display the segment in the HOME folder or not - defaults to `false`
- fetch_version: `boolean` - display the Cloud Foundry CLI version - defaults to `true`
2022-02-16 08:23:40 -08:00
- missing_command_text: `string` - text to display when the java command is missing - defaults to empty
- display_mode: `string` - determines when the segment is displayed
- `always`: the segment is always displayed
- `files`: the segment is displayed when `manifest.yml` or `mta.yaml` file is present (default)
- version_url_template: `string` - a go [text/template][go-text-template] [template][templates] that creates
the URL of the version info / release notes
2022-02-16 08:23:40 -08:00
## Template ([info][templates])
:::note default template
```template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}
```
:::
### Properties
2022-02-16 08:23:40 -08:00
- `.Full`: `string` - the full version
- `.Major`: `string` - major number
- `.Minor`: `string` - minor number
- `.Patch`: `string` - patch number
- `.URL`: `string` - URL of the version info / release notes
- `.Error`: `string` - error encountered when fetching the version string
2022-02-16 08:23:40 -08:00
[go-text-template]: https://golang.org/pkg/text/template/
2022-04-20 09:43:59 -07:00
[templates]: /docs/configuration/templates
2022-02-16 08:23:40 -08:00
[cloud-foundry]: https://github.com/cloudfoundry/cli