oh-my-posh/docs/docs/segment-cf.md
2022-03-27 15:42:42 +02:00

1.5 KiB

id title sidebar_label
cf Cloud Foundry Cloud Foundry

What

Display the active Cloud Foundry CLI version.

Sample Configuration

{
  "background": "#a7cae1",
  "foreground": "#100e23",
  "powerline_symbol": "\ue0b0",
  "template": " \uf40a cf {{ .Full }} ",
  "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
  • display_error: boolean - show the error context when failing to retrieve the version information - defaults to true
  • 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)

Template (info)

:::note default template

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

:::

Template Properties

  • .Full: string - the full version
  • .Major: string - major number
  • .Minor: string - minor number
  • .Patch: string - patch number
  • .Prerelease: string - prerelease info text
  • .BuildMetadata: string - build metadata
  • .Error: string - when fetching the version string errors