This repository contains a collection of helper functions and aliases that will hopefully make your git-driven life easier.
See gitconfig file for useful commands
-
Clone the githelpers repository:
git clone [email protected]:nbroslawsky/githelpers.git ~/githelpers
-
Set up your username and email globally. After doing so, you'll have a .gitconfig file in your home directory:
git config --global user.name "Your Name" git config --global user.email "[email protected]"
-
Allow git to pull our new configuration (provided that you are using git 1.7.10+):
git config --global include.path "~/githelpers/gitconfig" -
Update your Zsh profile (~/.zshrc) to include the init.sh script from this repo:
echo 'source ~/githelpers/zsh_setup.sh' >> ~/.zshrc
-
Optionally, enhance your prompt by including information about the repository that is checked out (e.g., branch, modifications, etc.).
PS1 is an environment variable in Unix-like operating systems, including Zsh, Bash, and other shells. It stands for "Prompt String 1" and defines the format of the primary prompt that appears in the command line. The contents of PS1 are used to customize how the shell prompt looks and what information it displays.
The prompt is the text that appears in the terminal before the cursor, indicating that the shell is ready to accept input. By customizing PS1, you can control the appearance of this prompt, including adding colors, displaying information about the current working directory, showing the username, hostname, and more.
_For example, the PS1 setting: PS1="%n@%m %1~ $ "
Breaks down as follows:
%n: username.
%m: machine name (hostname).
%1~: abbreviated current working directory.
$: the prompt symbol.
The following example looks good on a darker background (color aliases are defined in
~~PS1="${YELLOW}%n@%m ${RESET}%1~ ${CYAN}$(__git_ps1 '(%s) ')${RESET}$ "~~colors):
If you already have your PS1 set up the way you like it, the important thing is to add ${CYAN}\$(__git_ps1 '(%s) ')${RESET} somewhere inside it.