A PowerShell port of git-radar. A heads up display for git.
git-radar is the most useful bash prompt I have used for working with git repositories, I just had to have it in PowerShell!
I'd love to bring more features to this module so if you have some spare time and find it useful, help is always welcome.
The Git Radar prompt will automatically toggle after you import the Git-PsRadar module in to your session and cd in to a git repository. The example below shows the mater branch with 1 modified file staged for commit, 1 deleted, 1 modified and 2 new files not yet staged for commit.
Tip! Git-PsRadar works best with font Lucida Console at size 16.
The prompt will show you the difference in commits between your branch and the
remote your branch is tracking. The examples below assume you are checked out on
master and are tracking origin/master.
There are 4 commits to push up, 1 modified and 3 new files not yet staged to commit
There is 1 commit to pull down, 1 new and 1 modified files staged for commit
master and origin/master have diverged. We have 1 change to pull down and 3 to push.
origin/master and origin/tmp have diverged(m 28 <-> 7 tmp). Our local tmp branch also has 15 changes to pull and 1 to push up to origin/tmp. Essentally the arrows in the middle show branch diversions on the server and the arrows to the right show diversions between the local branch and the remote branch it's tracking on the server.
There is 1 item in our stash stack
origin/master has divered by 1 commit from our local tmp branch
tmp branch is locally ahead by 1 commit from origin/master (blue arrow)
origin/tmp ahead by 1 commit from origin/master (green arrow)
Git-PsRadar requires that the git executable be in your path in order for background fetch to work. This is due to a limitation in the libgit library.
When entering a git repository at the command line, Git-PsRadar will place a 0 length file in your .git directory called lastupdatetime. If the modified date shows it's older than 5 minutes, a background git fetch (which won't affect your current working copy) will be performed which will then show pending changes in the PowerShell HUD prompt. It's a feature I intend to make configurable in the near future.
There are two ways to install Git-PsRadar.
For those with Windows 10 and above, you can issue a Install-Module -Name Git-PsRadar command.
For those with Windows Vista or 7 who are using PowerShell version 3 or 4, you'll need to install PackageManagement first before executing Install-Module -Name Git-PsRadar.
See the module listing in the official PowerShell gallary
Download the Git-PsRadar.psm1 file and copy it into a directory called Git-PsRadar in your PowerShell module directory. It should be $env:USERPROFILE\Documents\WindowsPowerShell\Modules\Git-PsRadar.
Assuming you want Git-PsRadar to be avilable in every PowerShell session, open your profile script located at $env:USERPROFILE\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1 and add the following line.
Import-Module Git-PsRadar
If your going to load Git-PsRadar in your profile, please ensure
Import-Module Git-PsRadaris executed after yourprompt {}declaration. If you don't have a custompromptdeclared then you don't need to worry.
If the file Microsoft.PowerShell_profile.ps1 does not exist, you can simply create it and it will be executed the next time a PowerShell session starts.
I'll be working on this script as time permits, but I am keen to bring across all features.