oh-my-posh/docs/docs/segment-terraform.md
2021-11-20 10:14:26 +00:00

36 lines
766 B
Markdown

---
id: terraform
title: Terraform Context
sidebar_label: Terraform
---
## What
Display the currently active Terraform Workspace name.
:::caution
This requires a terraform binary in your PATH and will only show in directories that contain a `.terraform` subdirectory
:::
## Sample Configuration
```json
{
"type": "terraform",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#000000",
"background": "#ebcc34",
"properties": {
"template": "{{.WorkspaceName}}"
},
}
```
- template: `string` - A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the
properties below - defaults to `{{ .WorkspaceName }}> `
## Template Properties
- `.WorkspaceName`: `string` - is the current workspace name