---
id: ruby
title: Ruby
sidebar_label: Ruby
---

## What

Display the currently active ruby version.

## Sample Configuration

import Config from "@site/src/components/Config.js";

<Config
  data={{
    type: "ruby",
    style: "powerline",
    powerline_symbol: "\uE0B0",
    foreground: "#ffffff",
    background: "#4063D8",
    template: " \uE791 {{ .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 ruby version                                                                                                                                                                                                               |
| `missing_command_text` | `string`   |                           | text to display when the command is missing                                                                                                                                                                                          |
| `display_mode`         | `string`   | `context`                 | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string`   |                           | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes                                                                                                                |
| `extensions`           | `[]string` | `*.rb, Rakefile, Gemfile` | allows to override the default list of file extensions to validate                                                                                                                                                                   |
| `folders`              | `[]string` |                           | allows to override the list of folder names to validate                                                                                                                                                                              |
| `cache_version`        | `boolean`  | `false`                   | cache the executable's version or not                                                                                                                                                                                                |

## Template ([info][templates])

:::note default template

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

:::

### Properties

| Name     | Type     | Description                                        |
| -------- | -------- | -------------------------------------------------- |
| `.Full`  | `string` | the full version                                   |
| `.Error` | `string` | error encountered when fetching the version string |

[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates