oh-my-posh/website/docs/introduction.md

id	title	sidebar_label	slug
introduction	Introduction	👋 Introduction	/

Oh My Posh is a custom prompt engine for any shell that has the ability to adjust the prompt string with a function or variable.

Concept

Traditionally, prompt tools work with custom scripts per theme (just like Oh My Posh 2 did) or a lot of CLI configuration switches to define what it looks like. With Oh My Posh, I wanted to start from a single configuration file that could easily be shared anywhere, removing the need to really grasp what goes on underneath.

When you look at prompts like Agnoster or Paradox, you notice they usually consist of a few building blocks which contain one or more segments that display some sort of information. The configuration of Oh My Posh works exactly like that. Blocks are a combination of one or more segments.

The basic layout of the config file is as follows.

{
    "blocks": []
}

A block has properties that indicate its position and the segments it will render.

{
    "blocks": [
        {
            // positioning metadata (not shown)
            "segments": []
        }
    ]
}

A segment renders a single context like showing the current folder, user information or git status when relevant. It can be styled any way you want, resulting in visualizing the prompt you are looking for.

For your convenience, the existing themes from Oh My Posh have been added to version 3, so you can get started even without having to understand the theming. So, let's no longer waste time on theory, have a look at the installation guide to get started right away!