Buf

What

Display the currently active Buf CLI version.

Sample Configuration

json

{
  "type": "buf",
  "style": "plain",
  "foreground": "#1000D6",
  "template": " 🐃 {{ .Full }} "
}

yaml

type: buf
style: plain
foreground: "#1000D6"
template: " 🐃 {{ .Full }} "

toml

type = "buf"
style = "plain"
foreground = "#1000D6"
template = " 🐃 {{ .Full }} "

Properties

Name	Type	Default	Description
home_enabled	boolean	false	display the segment in the HOME folder or not
fetch_version	boolean	true	fetch the active version or not; useful if all you need is an icon indicating buf
cache_duration	string	24h	the 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_text	string		text to display when the command is missing
display_mode	string	context	always: the segment is always displayed files: the segment is only displayed when file extensions listed are present context: displays the segment when the environment or files is active
version_url_template	string		a go text/template template that creates the URL of the version info / release notes
extensions	[]string	buf.yaml, buf.gen.yaml, buf.work.yaml	allows to override the default list of file extensions to validate
folders	[]string		allows to override the list of folder names to validate

Template (info)

default template

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

Properties

Name	Type	Description
.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