---
id: ocaml
title: Ocaml
sidebar_label: Ocaml
---

## What

Display the currently active OCaml version.

## Sample Configuration

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

<Config
  data={{
    type: "ocaml",
    style: "powerline",
    powerline_symbol: "\uE0B0",
    foreground: "#d08770",
    template: " \ue67a {{ .Full }} ",
  }}
/>

## Properties

| Name                   | Type       | Description                                                                                                                                                                          |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled`         | `boolean`  | display the segment in the HOME folder or not - defaults to `false`                                                                                                                  |
| `fetch_version`        | `boolean`  | display the ocaml version (`ocaml -version`) - defaults to `true`                                                                                                                    |
| `missing_command_text` | `string`   | text to display when the command is missing - defaults to empty                                                                                                                      |
| `display_mode`         | `string`   | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.rs`, `Cargo.toml` or `Cargo.lock` files are present (**default**)</li></ul> |
| `extensions`           | `[]string` | 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`  | cache the executable's version or not - defaults to `false`                                                                                                                          |

## Template ([info][templates])

:::note default template

```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                                       |
| `.Prerelease` | `string` | channel name                                       |
| `.Error`      | `string` | error encountered when fetching the version string |

[templates]: /docs/configuration/templates