2019-03-13 04:14:30 -07:00
# A prompt theme engine for any shell
2020-10-04 11:24:52 -07:00
![Release Status][release-status]
[![Go Report Card][report-card]][report-card-link]
2020-10-03 11:36:49 -07:00
[![PS Gallery][psgallery-badge]][powershell-gallery]
2020-10-04 11:24:52 -07:00
[![Documentation][docs-badge]][docs]
2019-03-13 04:14:30 -07:00
What started as the offspring of [oh-my-posh][oh-my-posh] 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.
## ❤ Support ❤
[![Patreon][patreon-badge]][patreon]
[![Liberapay][liberapay-badge]][liberapay]
[![Ko-Fi][kofi-badge]][kofi]
## Features
2020-10-04 11:24:52 -07:00
* Shell independant
2019-03-13 04:14:30 -07:00
* Git status indications
* Failed command indication
* Admin indication
* Current session indications
2020-10-04 11:24:52 -07:00
* Language info
* Shell info
2019-03-13 04:14:30 -07:00
* Configurable
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
## Roadmap
* [x] CI
* [x] Github Releases
* [x] Create documentation for manual installation
2020-10-04 11:24:52 -07:00
* [x] Create documentation on the different segments
2019-03-13 04:14:30 -07:00
* Create easy installation packages
2020-09-17 08:06:02 -07:00
* [x] Powershell
2019-03-13 04:14:30 -07:00
* [ ] Brew
* [ ] Chocolatey
## Thanks
* [Chris Benti][chrisbenti-psconfig] for providing the first influence to start oh-my-posh
* [Keith Dahlby][keithdahlby-poshgit] for creating posh-git and making life more enjoyable
* [Robby Russel][oh-my-zsh] for creating oh-my-zsh, without him this would probably not be here
* [Janne Mareike Koschinski][justjanne] for providing information on how to get certain information using Go (and the amazing [README][powerline-go])
2020-10-04 11:24:52 -07:00
[release-status]: https://github.com/jandedobbeleer/oh-my-posh3/workflows/Release/badge.svg
2020-10-03 11:36:49 -07:00
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/oh-my-posh.svg
[powershell-gallery]: https://www.powershellgallery.com/packages/oh-my-posh/
2020-10-04 11:24:52 -07:00
[report-card]: https://goreportcard.com/badge/github.com/jandedobbeleer/oh-my-posh3
[report-card-link]: https://goreportcard.com/report/github.com/jandedobbeleer/oh-my-posh3
2019-03-13 04:14:30 -07:00
[oh-my-posh]: https://github.com/JanDeDobbeleer/oh-my-posh
[patreon-badge]: https://img.shields.io/badge/Support-Become%20a%20Patreon!-red.svg
[patreon]: https://www.patreon.com/jandedobbeleer
[liberapay-badge]: https://img.shields.io/badge/Liberapay-Donate-%23f6c915.svg
[liberapay]: https://liberapay.com/jandedobbeleer
[kofi-badge]: https://img.shields.io/badge/Ko--fi-Buy%20me%20a%20coffee!-%2346b798.svg
[kofi]: https://ko-fi.com/jandedobbeleer
2020-10-04 11:24:52 -07:00
[docs-badge]: https://img.shields.io/badge/documentation-ohmyposh.dev-blue
[docs]: https://ohmyposh.dev/docs
2019-03-13 04:14:30 -07:00
[chrisbenti-psconfig]: https://github.com/chrisbenti/PS-Config
[keithdahlby-poshgit]: https://github.com/dahlbyk/posh-git
[oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
[justjanne]: https://github.com/justjanne
[powerline-go]: https://github.com/justjanne/powerline-go
