Back to Oh My Posh

Cloud Foundry

website/docs/segments/cloud/cf.mdx

29.12.04.5 KB
Original Source

What

Display the active Cloud Foundry CLI version.

Sample Configuration

import Config from "@site/src/components/Config.js";

<Config data={{ background: "#a7cae1", foreground: "#100e23", powerline_symbol: "\ue0b0", template: " \uf40a cf {{ .Full }} ", style: "powerline", type: "cf", }} />

Options

NameTypeDefaultDescription
home_enabledbooleanfalsedisplay the segment in the HOME folder or not
fetch_versionbooleantruedisplay the Cloud Foundry CLI version
cache_durationstringnonethe duration for which the version will be cached. The duration is a string in the format 1h2m3s and is parsed using the time.ParseDuration function from the Go standard library. To disable the cache, use none
missing_command_textstringtext to display when the java command is missing
display_modestringcontext<ul><li>always: the segment is always displayed</li><li>files: the segment is only displayed when file extensions listed are present</li><li>context: displays the segment when the environment or files is active</li></ul>
version_url_templatestringa go text/template template that creates the URL of the version info / release notes
extensions[]stringmanifest.yml, mta.yamlallows to override the default list of file extensions to validate
folders[]stringallows to override the list of folder names to validate
tooling[]stringcfthe tooling to use for fetching the version

Template (info)

:::note default template

template
{{ if .Error }}{{ .Error }}{{ else }}{{ .Full }}{{ end }}

:::

Properties

NameTypeDescription
.Fullstringthe full version
.Majorstringmajor number
.Minorstringminor number
.Patchstringpatch number
.URLstringURL of the version info / release notes
.Errorstringerror encountered when fetching the version string