Skip to main content

Segment

A segment is a part of the prompt with a certain context. There are different types available out-of-the-box, if you're looking for what's included, feel free to skip this part and browse through the segments. Keep reading to understand how to configure a segment.

{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json",
...
"blocks": [
{
...
"segments": [
{
"type": "path",
"style": "powerline",
"powerline_symbol": "\uE0B0",
"foreground": "#ffffff",
"background": "#61AFEF",
"template": " {{ .Path }}} ",
"properties": {
...
}
}
]
}
]
}
NameTypeDescription
typestringtakes the string value referencing which segment logic it needs to run (see segments for possible values)
stylestringsee Style below. Possible values:
  • powerline
  • plain
  • diamond
  • accordion
powerline_symbolstringcharacter to use when "style": "powerline"
invert_powerlinebooleanif true swaps the foreground and background colors. Can be useful when the character you want does not exist in the perfectly mirrored variant for example - defaults to false
leading_diamondstringcharacter to use at the start of the segment. Will take the background color of the segment as its foreground color
trailing_diamondstringcharacter to use at the end of the segment. Will take the background color of the segment as its foreground color
foregroundstringcolor
foreground_templates[]Templatecolor templates
backgroundstringcolor
background_templates[]Templatecolor templates
templatestringa go text/template template to render the prompt
templates[]Templatein some cases having a single template string is a bit cumbersome. Templates allows you to span the segment's template string multiple lines where every template is evaluated and depending on what you aim to achieve, there are two possible outcomes based on templates_logic
templates_logicstring
  • first_match: return the first non-whitespace string and skip everything else
  • join:evaluate all templates and join all non-whitespace strings (default)
properties[]Propertysee Properties below
interactivebooleanwhen is true, the segment text is not escaped to allow the use of interactive prompt escape sequences - defaults to false
aliasstringfor use with cross segment template properties

Styleโ€‹

Style defines how a prompt is rendered. Looking at the most prompt themes out there, we identified 3 types. All of these require a different configuration and depending on the look you want to achieve you might need to understand/use them all.

Powerlineโ€‹

What started it all for us. Makes use of a single symbol (powerline_symbol) to separate the segments. It takes the background color of the previous segment (or transparent if none) and the foreground of the current one (or transparent if we're at the last segment). Expects segments to have a colored background, else there little use for this one.

Plainโ€‹

Simple. Colored text on a transparent background. Make sure to set foreground for maximum enjoyment. Segments will be separated by empty spaces unless you specify '' for the prefix and postfix settings for the segment.

Diamondโ€‹

While Powerline works great with a single symbol, sometimes you want a segment to have a different start and end symbol. Just like a diamond: < my segment text >. The difference between this and plain is that the diamond symbols take the segment background as their foreground color.

Accordionโ€‹

Same as Powerline except that it will display even when disabled, but without text. That way it seems as if the segment is not expanded, just like an accordion.

Propertiesโ€‹

An array of Properties with a value. This is used inside of the segment logic to tweak what the output of the segment will be. Segments have the ability to define their own Properties, but there are some shared ones being used by the engine which allow you to customize the output even more.

Shared propertiesโ€‹

You can use these on any segment, the engine is responsible for adding them correctly.

NameType
include_folders[]string
exclude_folders[]string

Include / Exclude Foldersโ€‹

Sometimes you might want to have a segment only rendered in certain folders. If include_folders is specified, the segment will only be rendered when in one of those locations. If exclude_folders is specified, the segment will not be rendered when in one of the excluded locations.

"include_folders": [
"/Users/posh/Projects"
]
"exclude_folders": [
"/Users/posh/Projects"
]

The strings specified in these properties are evaluated as regular expressions. You can use any valid regular expression construct, but the regular expression must match the entire directory name. The following will match /Users/posh/Projects/Foo but not /home/Users/posh/Projects/Foo.

"include_folders": [
"/Users/posh/Projects.*"
]

You can also combine these properties:

"include_folders": [
"/Users/posh/Projects.*"
],
"exclude_folders": [
"/Users/posh/Projects/secret-project.*"
]

Notesโ€‹

  • Oh My Posh will accept both / and \ as path separators for a folder and will match regardless of which is used by the current operating system.
  • Because the strings are evaluated as regular expressions, if you want to use a \ in a Windows directory name, you need to specify it as \\\\.
  • The character ~ at the start of a specified folder will match the user's home directory.
  • The comparison is case-insensitive on Windows and macOS, but case-sensitive on other operating systems.

This means that for user Bill, who has a user account Bill on Windows and bill on Linux, ~/Foo might match C:\Users\Bill\Foo or C:\Users\Bill\foo on Windows but only /home/bill/Foo on Linux.