Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/warbacon/zunder-prompt
⚡ Simple and fast zsh prompt based on gitstatus.
https://github.com/warbacon/zunder-prompt
git gitstatus prompt shell starship zsh zsh-plugin zsh-prompt zsh-theme zunder-zsh
Last synced: 5 days ago
JSON representation
⚡ Simple and fast zsh prompt based on gitstatus.
- Host: GitHub
- URL: https://github.com/warbacon/zunder-prompt
- Owner: warbacon
- License: gpl-3.0
- Created: 2023-04-30T19:18:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-09T10:21:17.000Z (3 months ago)
- Last Synced: 2024-08-09T11:51:31.221Z (3 months ago)
- Topics: git, gitstatus, prompt, shell, starship, zsh, zsh-plugin, zsh-prompt, zsh-theme, zunder-zsh
- Language: Shell
- Homepage:
- Size: 150 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zunder-prompt
Simple and fast zsh prompt based on [gitstatus](https://github.com/romkatv/gitstatus).
> [!IMPORTANT]
> gitstatus officially went on life support on June 6, 2024, although it is
> working properly as of today and will probably do so for an almost indefinite
> period of time.
## Why? 🤔
I found myself oscillating between **Starship** and **Powerlevel10k** for my preferred
zsh prompt. Starship is very customizable and attractive by default,
but it has too many features that I don't use and that makes it slower than
I would like. Powerlevel10k on the other hand is extremely fast but the
configuration file is extremely complex.
My goal then was to create a prompt with the **basic functionality needed**.
After mulling this over, I came to the conclusion that simply seeing if
the previous command had failed and the information from the git repository
I was in was enough.
I also decided to **dispense with too many advanced customization options**,
as that would complicate the code and would not be necessary
if it was already pretty enough by default.
Zunder-prompt is inspired by Starship for its look and feel and uses
gitstatus to display git information. Normally the latter should slow down
the prompt quite a bit, however, this project is the same one that Powerlevel10k
uses for it and is extremely optimized, so the prompt has **no lag**
at all and **works instantly**.
## Installation ⚙️
### [Zinit](https://github.com/zdharma-continuum/zinit) (recomended)
```sh
zinit light-mode depth"1" for \
romkatv/gitstatus \
warbacon/zunder-prompt
```
### [Zgenom](https://github.com/jandamm/zgenom)
```sh
if ! zgenom saved; then
# ...
zgenom load romkatv/gitstatus
zgenom load warbacon/zunder-prompt
# ...
fi
```
### [Zplug](https://github.com/zplug/zplug)
```sh
zplug "romkatv/gitstatus", depth:1
zplug "warbacon/zunder-prompt", on:"romkatv/gitstatus", depth=1
```
## Customization 🎨
As zunder-prompt is built with simplicity and speed in mind, there isn't too
much customization available. However, you can change the prompt's character
symbol.
```sh
ZUNDER_PROMPT_CHAR="➜" # default value: "❯"
```
## Thanks to
- [romkatv](https://github.com/romkatv) for gitsatus.
- [Starship](https://starship.rs/) for inspiration.