oh-my-posh/website/docs/segments/crystal.md

1.5 KiB

id title sidebar_label
crystal Crystal Crystal

What

Display the currently active crystal version.

Sample Configuration

{
  "type": "crystal",
  "style": "powerline",
  "powerline_symbol": "\uE0B0",
  "foreground": "#ffffff",
  "background": "#4063D8",
  "template": " \uE370 {{ .Full }} "
}

Properties

  • home_enabled: boolean - display the segment in the HOME folder or not - defaults to false
  • fetch_version: boolean - fetch the julia version - defaults to true
  • missing_command_text: string - text to display when the 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 only displayed when *.cr or shard.yml files are present (default)
  • version_url_template: string - a go text/template template that creates the URL of the version info / release notes

Template (info)

:::note default template

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

:::

Properties

  • .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