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]
|
2021-05-15 04:41:01 -07:00
|
|
|
|
|
|
|
|
[![Release][release-badge]][release]
|
2020-10-04 11:24:52 -07:00
|
|
|
[![Documentation][docs-badge]][docs]
|
2019-03-13 04:14:30 -07:00
|
|
|
|
2021-05-15 04:41:01 -07:00
|
|
|
[![PS Gallery][psgallery-badge]][powershell-gallery]
|
|
|
|
|
![GitHub Downloads][gh-downloads]
|
|
|
|
|
|
2021-02-18 16:47:18 -08:00
|
|
|
What started as the offspring of [oh-my-posh2][oh-my-posh2] for PowerShell resulted in a cross platform,
|
2020-12-14 04:06:19 -08:00
|
|
|
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
|
|
|
|
|
|
|
|
## ❤ Support ❤
|
|
|
|
|
|
|
|
|
|
[![Patreon][patreon-badge]][patreon]
|
|
|
|
|
[![Liberapay][liberapay-badge]][liberapay]
|
|
|
|
|
[![Ko-Fi][kofi-badge]][kofi]
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2020-12-24 09:05:14 -08:00
|
|
|
* Shell independent
|
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
|
2020-12-14 04:06:19 -08:00
|
|
|
* [x] Brew
|
|
|
|
|
* [x] Scoop
|
2021-04-11 11:12:49 -07:00
|
|
|
* [ ] Winget
|
|
|
|
|
* [x] Swap V2 with V3
|
2019-03-13 04:14:30 -07:00
|
|
|
|
|
|
|
|
## 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
|
2020-12-14 04:06:19 -08:00
|
|
|
* [Janne Mareike Koschinski][justjanne] for providing information on how to get certain information
|
|
|
|
|
using Go (and the amazing [README][powerline-go])
|
2020-12-22 10:31:20 -08:00
|
|
|
* [Starship][starship] for creating an amazing way to initialize the prompt
|
2019-03-13 04:14:30 -07:00
|
|
|
|
2021-05-15 04:41:01 -07:00
|
|
|
[release-status]: https://img.shields.io/github/workflow/status/jandedobbeleer/oh-my-posh/Release?label=Build
|
|
|
|
|
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/oh-my-posh?color=pink&label=PowerShell%20Downloads
|
2020-10-03 11:36:49 -07:00
|
|
|
[powershell-gallery]: https://www.powershellgallery.com/packages/oh-my-posh/
|
2021-05-15 04:41:01 -07:00
|
|
|
[gh-downloads]: https://img.shields.io/github/downloads/jandedobbeleer/oh-my-posh/total?color=pink&label=GitHub%20Downloads
|
2021-02-15 23:36:37 -08:00
|
|
|
[report-card]: https://goreportcard.com/badge/github.com/jandedobbeleer/oh-my-posh
|
|
|
|
|
[report-card-link]: https://goreportcard.com/report/github.com/jandedobbeleer/oh-my-posh
|
2021-02-18 16:47:18 -08:00
|
|
|
[oh-my-posh2]: https://github.com/JanDeDobbeleer/oh-my-posh2
|
2019-03-13 04:14:30 -07:00
|
|
|
[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
|
2021-05-15 04:41:01 -07:00
|
|
|
[docs-badge]: https://img.shields.io/badge/Docs-ohmyposh.dev-blue
|
2020-10-04 11:24:52 -07:00
|
|
|
[docs]: https://ohmyposh.dev/docs
|
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
|
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
|
2020-12-22 10:31:20 -08:00
|
|
|
[starship]: https://github.com/starship/starship/blob/master/src/init/mod.rs
|
