Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pablopunk/bashy
Extremely fast and simple git prompt for bash and zsh
https://github.com/pablopunk/bashy
bash bashy command git prompt repo terminal zsh
Last synced: 3 months ago
JSON representation
Extremely fast and simple git prompt for bash and zsh
- Host: GitHub
- URL: https://github.com/pablopunk/bashy
- Owner: pablopunk
- License: mit
- Created: 2017-05-20T20:00:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T23:11:12.000Z (about 1 year ago)
- Last Synced: 2024-05-02T05:12:15.582Z (8 months ago)
- Topics: bash, bashy, command, git, prompt, repo, terminal, zsh
- Language: Shell
- Homepage: https://www.npmjs.com/package/bashy
- Size: 29.3 KB
- Stars: 45
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
- awesome-discoveries - bashy - extremely fast and simple git prompt for bash _(`Bash`)_ (Git and Version Control Systems)
README
# Bashy ⚡️⌨️
Extremely fast and simple git prompt for bash
## Install
You can use the executable from this repo or install it with [npm](https://www.npmjs.com/)
```bash
npm install -g bashy
```
## Usage
In your `~/.bashrc` (linux) or `~/.bash_profile` (MacOS) you need to add `bashy` to your `$PS1`:
```bash
export PS1='$(bashy) $ '
```
This example will give you the next prompt:
```bash
repo at branch✓ $ # if you are in a git repo
folder $ # otherwise
```
You can also choose a path relative to your home folder with the option `-r`:
```bash
export PS1='$(bashy -r) $ '
# results in
~/repos/bashy at master $
```
NOTE: Since version *2.5.0* `bashy` does not support branch status on subdirectories of a repo. This decision meant a 2x increase in performance.
## Benchmarks
I've been a `zsh` user for a long time just for the prompts of `oh-my-zsh`. But because `oh-my-zsh` started to slow my prompt so much I decided to go back to `bash` and make my own customizations.
The first tool I used to do so was `vcprompt`, but the speed was not improving a lot.
If we compare `bashy` to other tools like `vcprompt` we can see is much faster:
```bash
$ time vcprompt
real 0m0.094s
user 0m0.037s
sys 0m0.024s
$ time bashy
real 0m0.010s
user 0m0.004s
sys 0m0.003s
```
> Okay, `bashy` is faster but, come on, `0.094s` is still very fast.
__Yes and no__. While times like those can be indistinguishable for humans, you can totally notice the difference in slower systems and also in fast terminal actions like:
## Customization
Okay okay, you don't care so much about the performance because you love customization, and tools like `vcprompt` are very good at that. While `bashy` does not have a built in customization option, __it's extremely easy to customize__. Just edit the script, purely bash, and write your own icons there, add more colors, or even rearrange the branch name and directory. Your imagination is the limit here.
You can use your own modified version of bashy cloning this repo and linking it with npm:
```bash
npm remove -g bashy # Uninstall the global bashy
git clone https://github.com/pablopunk/bashy # Clone this repo
cd bashy
npm link # Link
bashy # Use it!
```
## Zsh
If you still wanna use ZSH, __`bashy` will work as well as in bash__, but you need to set this option on your `.zshrc`: `setopt PROMPT_SUBST`.
## Troubleshooting
### Why is my `bashy` slow?
I've run into this recently. If you install `bashy` with `npm` and you're using a version manager for node (like `asdf`, `nvm`, etc...), the executable is not longer `bashy` directly, but the manager executable try to find bashy and run it after, which takes a long time (easily half a second).
## Author
|  |
| ----------------------------------------------------------------------------- |
| © 2017 [Pablo Varela](https://pablopunk.com) |