oh-my-posh README

The project's README from github.com/JanDeDobbeleer/oh-my-posh. As one markdown file: README.md.

Oh My Posh logo – Prompt theme engine for any shell

MIT license badge

Build Status badge

Release version number badge

Documentation link badge ohmyposh.dev

Number of GitHub Downloads badge

This repo was made with love using GitKraken.

GitKraken shield

Sponsors

CodeRabbit

Want to become a sponsor?

Join the community

Mastodon badge

Discord badge

What started as the offspring of oh-my-posh2 for PowerShell resulted in a cross platform, highly customizable and extensible prompt theme engine. After 4 years of working on oh-my-posh, a modern and more efficient tool was needed to suit my personal needs.

:heart: Support :heart:

Swag - Show your love with a t-shirt!

GitHub - One time support, or a recurring donation?

Ko-Fi - No coffee, no code.

Features

Documentation

Documentation

Reviews

Thanks

oh-my-posh (JanDeDobbeleer/oh-my-posh)

nushell
Searching Database…

What is this?oh-my-posh is a cross-platform prompt theme engine: it renders the prompt line you see in your terminal, and it is built to be highly customizable and extensible.
Does it replace my shell, or does it run inside the one I already have?It doesn't replace anything — your shell stays as is, and oh-my-posh only takes over drawing the prompt. The project describes itself as shell and platform agnostic.
How do I install it and switch my prompt to it?It ships as a single Go binary: install it for your OS using the guides at ohmyposh.dev, then point your shell config at oh-my-posh so it renders your prompt, and pick a theme.
Which shells can I use it with?Most of them: bash, zsh, fish, PowerShell, cmd and nushell are all supported, and it runs on Windows, macOS and Linux.
Will the icons in the themes just work, or do I need a special font?The themes lean on Nerd Fonts — fonts patched with extra icon glyphs (the repo carries a nerd-fonts topic) — so install one in your terminal for the icons to render correctly.
Why did the author rewrite it instead of continuing oh-my-posh2?oh-my-posh started as the offspring of oh-my-posh2 for PowerShell. After 4 years of working on it, the author needed a modern, more efficient tool to suit his personal needs — that became the cross-platform engine hosted in this repo.
What do right prompt, transient prompt and secondary prompt actually do?They are extra prompt surfaces: the right prompt places info on the right side of the terminal, the secondary prompt adds a second prompt line, and transient prompt lets lines you already entered collapse to a shorter form — more context without cluttering the active line.
Does it show git info in the prompt?Yes — git is one of its headline integrations and a core project topic: the prompt can reflect the repository you are in as you move around your filesystem.
Size
115.8 MB
Stars
23.6K
Age
7y
Commits · 90 Days