Colors - Oh My Posh — ContextQMD

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

Standard colors

Oh My Posh supports multiple different color references, being:

True color using hex colors (for example #CB4B16).
16 ANSI color names. These include 8 basic ANSI colors and default

black red green yellow blue magenta cyan white default

as well as 8 extended ANSI colors:

darkGray lightRed lightGreen lightYellow lightBlue lightMagenta lightCyan lightWhite
256 color palette using their number representation. For example 0 is black, 1 is red, 2 is green, etc.
The transparent keyword which can be used to create either a transparent foreground override or transparent background color using the segment's foreground property.
The foreground keyword which can be used to reference the current segment's foreground color.
The background keyword which can be used to reference the current segment's background color.
The parentForeground keyword which can be used to inherit the previous active segment's foreground color.
The parentBackground keyword which can be used to inherit the previous active segment's background color.
The accent keyword which references the OS accent color (Windows and macOS only).

Gradients

Anywhere a Standard color is expected, you can instead use a linear-gradient with two or more comma-separated stops:

The stops are spread evenly across the segment's visible text and interpolated per character cell. Each stop can be a hex color or a Palette reference (p:name), so gradients work with palette and palettes the same way Standard colors do. This applies to foreground, background, foreground_templates, background_templates, Palette entries, and cycle colors.

Powerline separators, diamond caps, and the parentBackground/parentForeground keywords automatically pick up the matching edge of the gradient, so a segment next to a gradient still connects with the right color.

Supported stops

A stop must resolve to a hex color before it can be interpolated:

Stop	Supported
Hex color (`#CB4B16`, `#F0A`)	yes
Palette reference to a hex color (`p:blue`)	yes
`parentBackground`, `parentForeground`, `background`, `foreground`	yes
`accent` (Windows and macOS only)	yes
ANSI color name (`red`, `lightBlue`)	no
256 color palette number (`146`)	no
`transparent`	no

Keyword stops resolve against the surrounding segments at render time and must land on a hex color; when the previous segment uses a gradient itself, parentBackground picks up its last stop, so linear-gradient(parentBackground, p:yellow) connects seamlessly to it. On platforms where the OS accent color is unavailable, an accent stop is invalid and the gradient falls back like any other invalid stop.

A background or foreground keyword in a color override inside a gradient segment resolves to the gradient's color at that position in the text: a leading <background,transparent> cap picks up the first stop, a trailing one the color where the gradient ends, so template caps stay seamless without hardcoding edge colors.

A gradient without at least two supported stops renders as a solid color: the last stop goes through the regular color pipeline, so linear-gradient(red, blue) renders solid blue rather than failing — matching the color its separators and width-collapsed form already use. Rejected stops are reported in oh-my-posh debug output.

Stops and segment width

The gradient always starts and ends exactly on the configured colors: the first stop lands on the first visible cell, the last stop on the last. Everything in between is interpolated, so a narrow segment simply shows a coarser gradient. A gradient needs at least two visible cells per stop to render per cell; narrower segments render the last stop as a solid color across the whole segment, including its caps and separators, rather than a coarse blend. Streaming placeholders are exempt: a pending segment's ... placeholder previews the gradient per cell regardless of its width. Rendering cost is negligible; the only overhead is the per-cell color escape, which grows the prompt string by a few bytes per character.

:::caution

Gradients aren't supported on segments with interactive: true; shell-expanded text throws off the cell count the gradient interpolates across.
A gradient can't span multiple segments; each segment's gradient is self-contained.
Only the stop-list syntax is supported. Angle or direction keywords (for example to right) are reserved but not implemented.
Terminals without truecolor support fall back to a banded 256-color approximation.

:::

Color templates

Array of string templates to define the color based on the current context. Under the hood this uses go's text/template feature extended with sprig and offers a few standard properties to work with. For segments, you can look at the Template Properties section in the documentation. The general template properties are listed here.

The following sample is based on the AWS Segment.

The logic is as follows: when foreground_templates contains an array, we will check every template line until there's one that returns a non-empty string. So, when the contents of .Profile contain the word default, the first template returns #FFA400 and that's the color that will be used. If it contains jan, it returns #f1184c. When none of the templates returns a value, the foreground value #ffffff is used as a fallback value.

Color overrides

You have the ability to override the foreground and/or background color for text in any property that accepts it. The syntax is custom but should be rather straight-forward: <foreground,background>text</>. For example, <#ffffff,#000000>this is white with black background</> <#FF479C>but this is pink</>. Anything between the color start <#FF479C> and end </> will be colored accordingly.

If you want to print a colored bracket that isn't the same as the segment's foreground, you can do so like this:

If you also wanted to change the background color in the previous command, you would do so like this:

To change only the background color, just omit the first color from the above string:

Palette

If your configuration defined the Palette, you can use the Palette reference p:<palette key> in places where the Standard color is expected.

Defining a Palette

Palette is a set of named Standard colors. To use a Palette, define a "palette" object at the top level of your configuration:

Color names (palette keys) can have any string value, so be creative. Color values, on the other hand, should adhere to the Standard color format, including transparent.

Alternatively, a palette value can be a template that resolves to any valid color value, including a Palette reference. The template is rendered every time the color is resolved, so it can use any of the global template properties to switch colors based on context. For example, to use a different color when a Git segment is active in the prompt:

Using a Palette

You can now use Palette references in any Segment's foreground, foreground_templates, background, background_templates properties, and other config properties that expect Standard color value. Palette reference format is p:<palette key>. Take a look at the Git segment using Palette references:

Having all of the colors defined in one place allows you to import existing color configurations (usually with slight tweaking to adhere to the format), easily change colors of multiple segments at once, and have a more organized configuration overall. Be creative!

Palette references and Standard colors

Using Palette does not interfere with using Standard colors in your configuration. You can still use Standard colors everywhere. This can be useful if you want to use a specific color for a single segment element, or in a Color override (Battery segment):

<Config data={{ type: "battery", style: "powerline", invert_powerline: true, powerline_symbol: "\uE0B2", foreground: "p:white", background: "p:black", options: { discharging_icon: "<#ffa500>-</> ", charging_icon: "+ ", charged_icon: "* ", }, }} />

Handling of invalid references

Should you use an invalid Palette reference as a color (for example typo p:bleu instead of p:blue), the Palette engine will use the Transparent keyword as a fallback value. So if you see your prompt segments rendered with incorrect colors, and you are using a Palette, be sure to check the correctness of your references.

Recursive resolution

Palette allows for recursive Palette reference resolution, up to 3 levels deep. You can use a Palette reference as a color value in Palette. This allows you to define named colors, and use references to those colors as Palette values. A template value that resolves to a Palette reference follows the same rules, and the referenced value can itself be a template. For example, p:foreground and p:background will be correctly set to "#CAF0F80" and "#023E8A":

Palettes

If you want to use a palette conditionally, for example for light or dark mode, you can define multiple palettes and a template that resolves to the palette key. The template is evaluated at runtime so your prompt can change at any time based on the outcome of the template.

Take the following configuration:

In this case, when the shell is pwsh, the latte palette will be used, otherwise it uses the frappe palette. If you want, you could also add frappe as the default palette, given that one is used as a fallback when not match can be found based on what the template resolves to. In case no match is available and no palette is defined, it will also fallback to transparent for any palette color reference in templates/colors.

If you want to avoid color duplication, you can use palettes in combination with the palette property. This way you can define a color once and reuse it in multiple palettes. For example:

:::info If a color is defined in both palette and palettes, the palettes' resolved color will take precedence. :::

Cycle

When you want to display the same sequence of colors (background and foreground) regardless of which segments are active, you can make use of the cycle property. This property is a list of colors which are used one after the other in a continuous loop. A defined cycle always gets precedence over everything else.