oh-my-posh/README.md

83 lines
3.4 KiB
Markdown
Raw Normal View History

2022-03-18 12:15:06 -07:00
<!-- markdownlint-disable -->
<p align="center">
<img
width="400"
2022-05-12 22:54:59 -07:00
src="https://raw.githubusercontent.com/jandedobbeleer/oh-my-posh/main/website/static/img/logo.png"
2023-10-29 18:44:02 -07:00
alt="Oh My Posh logo Prompt theme engine for any shell"
2022-03-18 12:15:06 -07:00
/>
</p>
<!-- markdownlint-enable -->
2019-03-13 04:14:30 -07:00
2023-10-29 18:44:02 -07:00
![MIT license badge](https://img.shields.io/github/license/JanDeDobbeleer/oh-my-posh.svg)
2023-04-07 02:42:21 -07:00
2023-10-29 18:44:02 -07:00
![Build Status badge](https://img.shields.io/github/actions/workflow/status/jandedobbeleer/oh-my-posh/release.yml?branch=main)
2021-05-15 04:41:01 -07:00
2023-12-25 11:53:40 -08:00
[![Release version number badge][release-badge]][release]
[![Documentation link badge ohmyposh.dev][docs-badge]][docs]
2019-03-13 04:14:30 -07:00
2023-10-29 18:44:02 -07:00
![Number of GitHub Downloads badge](https://img.shields.io/github/downloads/jandedobbeleer/oh-my-posh/total?color=pink&label=GitHub%20Downloads)
2021-05-15 04:41:01 -07:00
2022-02-03 02:58:57 -08:00
This repo was made with love using GitKraken.
[![GitKraken shield][kraken]][kraken-ref]
2022-12-23 00:49:33 -08:00
<!-- markdownlint-disable first-header-h1 -->
## Join the community
2023-10-29 18:44:02 -07:00
![Mastodon badge](https://img.shields.io/mastodon/follow/110275292073181892?domain=https%3A%2F%2Fhachyderm.io&label=Mastodon&style=social)
2022-12-23 00:49:33 -08:00
2023-10-29 18:44:02 -07:00
![Discord badge](https://img.shields.io/discord/1023597603331526656)
2022-02-03 02:58:57 -08:00
2023-10-29 18:44:02 -07:00
What started as the offspring of [oh-my-posh2](https://github.com/JanDeDobbeleer/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.
2019-03-13 04:14:30 -07:00
2023-10-29 18:44:02 -07:00
## :heart: Support :heart:
2019-03-13 04:14:30 -07:00
2022-03-18 12:15:06 -07:00
[![Swag][swag-badge]][swag] - Show your love with a t-shirt!
[![GitHub][github-badge]][github-sponsors] - One time support, or a recurring donation?
[![Ko-Fi][kofi-badge]][kofi] - No coffee, no code.
2019-03-13 04:14:30 -07:00
## Features
2022-02-28 04:07:10 -08:00
* Shell and platform agnostic
* Easily configurable
* The **most** configurable prompt utility
2021-12-22 04:22:59 -08:00
* Fast
2022-02-28 04:07:10 -08:00
* Secondary prompt
* Right prompt
* Transient prompt
2019-03-13 04:14:30 -07:00
2020-10-04 11:24:52 -07:00
## Documentation
2019-03-13 04:14:30 -07:00
2020-10-04 11:24:52 -07:00
[![Documentation][docs-badge]][docs]
2019-03-13 04:14:30 -07:00
2023-06-28 22:54:34 -07:00
## Reviews
2023-11-04 19:09:22 -07:00
* [Repo review](https://repo-reviews.github.io//reviews/2023-06-21_TameWizard_JanDeDobbeleer_oh-my-posh) by [TameWizard](https://github.com/TameWizard)
2023-06-28 22:54:34 -07:00
2019-03-13 04:14:30 -07:00
## Thanks
2023-10-29 18:44:02 -07:00
* [Chris Benti](https://github.com/chrisbenti/PS-Config) providing the first influence to start oh-my-posh
* [Keith Dahlby](https://github.com/dahlbyk/posh-git) for creating posh-git and making life more enjoyable
* [Robby Russell](https://github.com/ohmyzsh/ohmyzsh) for creating oh-my-zsh, without him this would probably not be here
* [Janne Mareike Koschinski](https://github.com/justjanne) for providing information on how to get certain information
using Go (and the amazing [README](https://github.com/justjanne/powerline-go))
* [Starship](https://github.com/starship/starship/blob/master/src/init/mod.rs) for doing great things
2022-02-03 02:58:57 -08:00
[kraken]: https://img.shields.io/badge/GitKraken-Legendary%20Git%20Tools-teal?style=plastic&logo=gitkraken
[kraken-ref]: https://www.gitkraken.com/invite/nQmDPR9D
2022-03-18 12:15:06 -07:00
[swag-badge]: https://img.shields.io/badge/Swag-Get%20some!-blue
[swag]: https://swag.ohmyposh.dev
[github-badge]: https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors
[github-sponsors]: https://github.com/sponsors/JanDeDobbeleer
2019-03-13 04:14:30 -07:00
[kofi-badge]: https://img.shields.io/badge/Ko--fi-Buy%20me%20a%20coffee!-%2346b798.svg
[kofi]: https://ko-fi.com/jandedobbeleer
2021-05-15 04:41:01 -07:00
[docs-badge]: https://img.shields.io/badge/Docs-ohmyposh.dev-blue
2022-03-18 12:15:06 -07:00
[docs]: https://ohmyposh.dev
2021-05-15 04:41:01 -07:00
[release-badge]: https://img.shields.io/github/v/release/jandedobbeleer/oh-my-posh?label=Release
[release]: https://github.com/JanDeDobbeleer/oh-my-posh/releases/latest