Oh My Posh

Oh My Posh configuration file

Type object
File match *.omp.json *.omp.toml *.omp.yaml *.omp.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/oh-my-posh/latest.json
Source https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

https://ohmyposh.dev/docs/configuration/general

Properties

enable_cursor_positioning boolean

https://ohmyposh.dev/docs/configuration/general#general-settings

Default: false
shell_integration boolean
Default: false
upgrade object

https://ohmyposh.dev/docs/configuration/general#general-settings

Default:
{
  "source": "cdn",
  "auto": false,
  "notice": false
}
4 nested properties
interval string

The duration for which the segment will be cached. This is parsed using the time.ParseDuration function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).

pattern=^(none|infinite|([0-9]+(h|m|s))+)$
source string
Default: "cdn"
Values: "cdn" "github"
auto boolean
Default: false
notice boolean
Default: false
console_title_template string

https://ohmyposh.dev/docs/configuration/title#console-title-template

Default: "{{ .Shell }} in {{ .Folder }}"
terminal_background color_string | palette_reference
streaming integer

https://ohmyposh.dev/docs/experimental/streaming

Default: 100
tooltips object[]

https://ohmyposh.dev/docs/configuration/tooltips

Default:
[]
transient_prompt object
Default:
{}
5 nested properties
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
valid_line object
Default:
{}
5 nested properties
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
error_line object
Default:
{}
5 nested properties
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
secondary_prompt object
Default:
{}
5 nested properties
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
debug_prompt object
Default:
{}
5 nested properties
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
palettes object

https://ohmyposh.dev/docs/configuration/colors#palettes

Default:
{}
2 nested properties
template string
list object
iterm_features string[]
async boolean
Default: false
tooltips_action string

https://ohmyposh.dev/docs/configuration/tooltips#tooltips-action

Default: "replace"
Values: "replace" "extend" "prepend"

Definitions

color color_string | palette_reference
templates template[]
home_enabled boolean

Display the segment in the HOME folder

fetch_version boolean

Fetch the version number

http_timeout integer

Milliseconds to use for http request timeouts

expires_in integer

Access token expiration time in seconds

access_token string

The initial access token

refresh_token string

The initial refresh token

display_mode string

Determines whether the segment is displayed always or only if a file matching the extensions are present in the current folder

missing_command_text string

The string to display when the command is not available

status_formats object

Override the status format for a specific change. Example: {"Added": "Added: %d"}

native_fallback boolean

Try to use the WSL 2 native command in a shared Windows drive if the Windows executable is not found.

branch_template string

the temaplate to use for the branch name, supports {{ .Branch }} for the branch name

mapped_branches object

Custom glyph/text for specific branches

cache_duration string

The duration for which the segment will be cached. This is parsed using the time.ParseDuration function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).

language_options object

Common options for language segments

home_enabled boolean

Display the segment in the HOME folder

Default: false
fetch_version boolean

Fetch the version number

Default: true
cache_duration string

The duration for which the segment will be cached. This is parsed using the time.ParseDuration function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).

pattern=^(none|infinite|([0-9]+(h|m|s))+)$
missing_command_text string

The string to display when the command is not available

Default: ""
display_mode string

Determines whether the segment is displayed always or only if a file matching the extensions are present in the current folder

Default: "context"
Values: "always" "files" "environment" "context"
version_url_template string

Template that creates the URL of the version info / release notes

Default: ""
tooling string[]

The tooling to use for fetching the version

Default:
[]
extensions string[]

The extensions to look for when determining if the current directory is a project

Default:
[]
folders string[]

The folders to look for when determining if a folder is a workspace

Default:
[]
filler string

Right aligned filler text, will span the remaining width.

aliases object

Custom value replacement for template parts

extra_prompt object
template string
foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
segment object

https://ohmyposh.dev/docs/configuration/segment

type string required

https://ohmyposh.dev/docs/configuration/segment

Values: "angular" "argocd" "aurelia" "aws" "az" "azd" "azfunc" "battery" "bazel" "brewfather" "buf" "bun" "carbonintensity" "cds" "cf" "cftarget" "claude" "clojure" "cmake" "copilot" "connection" "crystal" "dart" "deno" "docker" "dotnet" "elixir" "executiontime" "firebase" "flutter" "fortran" "fossil" "gcp" "git" "gitversion" "go" "haskell" "helm" "http" "ipify" "java" "jujutsu" "julia" "kotlin" "kubectl" "lastfm" "lua" "mercurial" "mojo" "mvn" "nba" "nbgv" "nightscout" "nim" "nix-shell" "node" "npm" "nx" "ocaml" "os" "owm" "path" "perl" "php" "plastic" "pnpm" "project" "pulumi" "python" "quasar" "r" "ramadan" "react" "root" "ruby" "rust" "sapling" "session" "shell" "sitecore" "spotify" "status" "strava" "svelte" "svn" "swift" "sysinfo" "talosctl" "taskwarrior" "tauri" "terraform" "text" "time" "todoist" "ui5tooling" "umbraco" "unity" "upgrade" "v" "vala" "wakatime" "winget" "winreg" "withings" "xmake" "yarn" "ytm" "zig"
style enum | string required

https://ohmyposh.dev/docs/configuration/segment#style

foreground color_string | palette_reference
foreground_templates template[]
Default:
[]
background color_string | palette_reference
background_templates template[]
Default:
[]
template string

https://ohmyposh.dev/docs/configuration/templates

Default: ""
templates_logic string

https://ohmyposh.dev/docs/configuration/segment

Values: "first_match" "join"
max_width integer

https://ohmyposh.dev/docs/configuration/segment

Default: 0
min_width integer

https://ohmyposh.dev/docs/configuration/segment

Default: 0
options object

https://ohmyposh.dev/docs/configuration/segment#options

Default:
{}
properties object

DEPRECATED: Use 'options' instead. This field is maintained for backward compatibility with version 3 configs and will be removed in a future version. See https://ohmyposh.dev/docs/configuration/segment#options

Default:
{}
interactive boolean

https://ohmyposh.dev/docs/configuration/segment

Default: false
alias string

https://ohmyposh.dev/docs/configuration/segment

Default: ""
include_folders string[]

https://ohmyposh.dev/docs/configuration/segment#include--exclude-folders

Default:
[]
exclude_folders string[]

https://ohmyposh.dev/docs/configuration/segment#include--exclude-folders

Default:
[]
cache object

https://ohmyposh.dev/docs/configuration/segment#cache

Default:
{}
2 nested properties
duration string

The duration for which the segment will be cached. This is parsed using the time.ParseDuration function from the Go standard library (see https://pkg.go.dev/time#ParseDuration for details).

pattern=^(none|infinite|([0-9]+(h|m|s))+)$
strategy string

https://ohmyposh.dev/docs/configuration/segment#strategy

Default: "folder"
Values: "folder" "session" "device"
placeholder string

Text to display while the segment is loading in streaming mode. See https://ohmyposh.dev/docs/experimental/streaming

Default: "..."