oh-my-posh/website/docs/segments/cloud/cftarget.mdx
2024-09-02 12:46:27 +02:00

54 lines
2 KiB
Plaintext

---
id: cftarget
title: Cloud Foundry Target
sidebar_label: Cloud Foundry Target
---
## What
Display the details of the logged [Cloud Foundry endpoint][cf-target] (`cf target` details).
## Sample Configuration
import Config from "@site/src/components/Config.js";
<Config
data={{
background: "#a7cae1",
foreground: "#100e23",
powerline_symbol: "\ue0b0",
template: " \uf40a {{ .Org }}/{{ .Space }} ",
style: "powerline",
type: "cftarget",
}}
/>
## Properties
| Name | Type | Default | Description |
| -------------- | :--------: | :----------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_mode` | `string` | `always` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `manifest.yml` file is present (or defined otherwise using `files`) </li></ul> |
| `files` | `[]string` | `["manifest.yml"]` | on which files to display the segment on. Will look in parent folders as well |
## Template ([info][templates])
:::note default template
```template
{{if .Org }}{{ .Org }}{{ end }}{{ if .Space }}/{{ .Space }}{{ end }}
```
:::
### Properties
| Name | Type | Description |
| -------- | -------- | -------------------------- |
| `.Org` | `string` | Cloud Foundry organization |
| `.Space` | `string` | Cloud Foundry space |
| `.URL` | `string` | Cloud Foundry API URL |
| `.User` | `string` | logged in user |
[templates]: /docs/configuration/templates
[cf-target]: https://cli.cloudfoundry.org/en-US/v8/target.html