Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luisprgr/zsh-show-git-user
A zsh plugin to easily show git user names in the zsh prompt
https://github.com/luisprgr/zsh-show-git-user
Last synced: about 2 months ago
JSON representation
A zsh plugin to easily show git user names in the zsh prompt
- Host: GitHub
- URL: https://github.com/luisprgr/zsh-show-git-user
- Owner: luisprgr
- License: mit
- Created: 2023-06-04T05:45:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-04T08:01:25.000Z (about 1 year ago)
- Last Synced: 2024-01-25T13:04:31.247Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - show-git-user - When you need to work with multiple `git` users on the same machine this plugin will show which `git` user name is active in your prompt. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - show-git-user - When you need to work with multiple `git` users on the same machine this plugin will show which `git` user name is active in your prompt. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - show-git-user - When you need to work with multiple `git` users on the same machine this plugin will show which `git` user name is active in your prompt. (Plugins / ZSH on Windows)
README
# zsh-show-git-user
There are some times when as a developer you need to work with multiple git users on the same machine, like when you need to have a work account separate from your personal account. This situation can be a bit difficult to manage, because you need to always remember change the git user for the project you are working on.
This zsh plugin helps you to add the current git user name to your zsh prompt, so you can always know which user you are using.
## Installation
### oh-my-zsh
1. Clone this repository in oh-my-zsh's custom plugins directory:
```
git clone https://github.com/luisprgr/zsh-show-git-user.git $ZSH_CUSTOM/plugins/zsh-show-git-user
```
2. Enable the plugin in `~/.zshrc`:
```
plugins=(your-other-plugins zsh-show-git-user)
```
## Usage
This plugin adds a new function called `git_user_name_prompt` that you can use to add the current git user name to your zsh prompt.
You can use it by adding a new line to your .zshrc like this one:
```
export PROMPT='$(git_user_name_prompt)'$PROMPT
```
## Some Configurations
### Show the git user name only when you are in a git repository
By default, the plugin will show the git user name in your prompt even if you are not in a git repository. If you want to show the git user name only when you are in a git repository, you can add the following line to your .zshrc:
```
export SHOW_GIT_USER_NAME_ONLY_IN_REPOS=true
```
### Don't show the git user name for a certain user
If you want to hide the prompt for a certain user, you can add the following line to your .zshrc:
```
export SHOW_GIT_USER_NAME_EXCEPT="user-name"
```
### Show the git user name in a different color
By default, the plugin will show the git user name in yellow. If you want use a different color, you can add the following line to your .zshrc:
```
export SHOW_GIT_USER_NAME_COLOR="color"
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details