GitHub - StartAutomating/ugit: Updated Git: A powerful PowerShell wrapper for git that lets you extend git, automate multiple repos, and output git as objects.

ugit (Updated Git) is a powerful PowerShell module for git that lets you: output git as objects, automate multiple repos, and extend git.

What is ugit?

ugit is a PowerShell module that gives you an updated git. You can use the object pipeline to pipe folders or files into git.
If you're using one of a number of supported commands, ugit will return your git output as objects. This enables a lot of interesting scenarios, giving you and updated way to work with git.

Getting started

# Install ugit from the PowerShell Gallery
Install-Module ugit -Scope CurrentUser
# Then import it.
Import-Module ugit -Force -PassThru

# Once you've imported ugit, just run git commands normally.
# If ugit has an extension for the command, it will output as an object.
# These objects can be formatted by PowerShell
git log -n 5 

# To get a sense of what you can do, pipe a given git command into Get-Member.
git log -n 5 |
  Get-Member

How ugit works:

ugit only has a few commands:

Use-Git

After you've imported ugit, Use-Git is what will be called when you run "git".

This happens because Use-Git is aliased to "git", and aliases are resolved first in PowerShell.

Use-Git assumes all positional parameters are arguments to Git, and passes them on directly.

This works in almost every scenario, except with some single character git options. You can pass these in quotes.

When Use-Git outputs, it sets $global:LastGitOutput and then pipes to Out-Git.

Out-Git

Out-Git will attempt to take git output and return it as a useful object.

This object can then be extended and formatted by PowerShell's Extended Type System.

Out-Git accomplishes this with several extensions. You can list extensions with Get-UGitExtension:

Get-UGitExtension

Get-UGitExtension enables any file beneath ugit (or a module that tags ugit) named *.ugit.extension.ps1 to be treated as an extension.

In ugit, extensions signal that they apply to a given git command by adding a [ValidatePattern] attribute to the command.

If this pattern matches the given git command, the extension will run.

Get-UGitExtension is built using Piecemeal

ugit examples

ugit comes packed with many examples. You might want to try giving some of these a try.

Git.Blame Example 1

Git.Branch.Input Example 1

Git.Branch Example 1

    git branch  # Get a list of branches

Git.Branch Example 2

    git branch |                                          # Get all branches
        Where-Object -Not IsCurrentBranch |               # where it is not the current branch
        Where-Object BranchName -NotIn 'main', 'master' | # and the name is not either main or master
        git branch -d                                     # then attempt to delete the branch.

Git.Checkout Example 1

    git checkout -b CreateNewBranch

Git.Checkout Example 2

Git.Clone.Input Example 1

    git clone https://github.com/MDN/content.git # This is a big repo.  Progress bars will be very welcome.

Git.Clone.Input Example 2

    # If we don't check things out, cloning is faster.
    git clone https://github.com/PowerShell/PowerShell -NoCheckout 
    # (of course, that's because we're not copying files, just history)

Git.Clone.Input Example 3

    # We can also clone more quickly by only picking a certain number of commits
    git clone https://github.com/Microsoft/vscode.git -Depth 1
    # (of course, this will make the history lie to you,
    # by saying everything was changed whenever anything was changed)

Git.Clone Example 1

    git clone https://github.com/StartAutomating/ugit.git

Git.Clone Example 2

    # Clone a large repo.
    # When --progress is provided, Write-Progress will be called.
    git clone https://github.com/Azure/azure-quickstart-templates --progress

Git.Commit.Input Example 1

    git commit -Title "Fixing Something"

Git.Commit.Input Example 2

    git commit -Title "Changing Stuff" -Trailers @{"Co-Authored-By"="SOMEONE ELSE <Someone@Else.com>"}

Git.Commit Example 1

    git commit -m "Updating #123"

Git.Commit Example 2

    $committedMessage = git commit -m "Committting Stuff" # Whoops, this commit had a typo
    $commitMessage.Amend("Committing stuff") # that's better

Git.Config.List Example 1

Git.Config.List Example 2

    git config --global --list

Git.Config.List Example 3

    git config --list --local

Git.Config.List Example 4

    git config --list --show-origin

Git.FileName Example 1

Git.FileOutput Example 1

Git.Format.Json Example 1

    git branch --format "{'ref':'%(refname:short)','parent':'%(parent)'}"

Git.Format.Simple Example 1

    git branch --format "%(refname:short)|%(objectname)|%(parent)|%(committerdate:iso8601)|%(objecttype)"

Git.Grep Example 1

    git grep '-i' example # look for all examples in the repository

Git.Help.All Example 1

Git.Help.All Example 2

Git.Init Example 1

    git init # Initialize the current directory as a repository

Git.Log.Input Example 1

Git.Log Example 1

    # Get all logs
    git log |
        # until the first merged pull request
        Where-Object -Not Merged

Git.Log Example 2

    # Get a single log entry
    git log -n 1 |
        # and see what the log object can do.
        Get-Member

Git.Log Example 3

    # Get all logs
    git log |
        # Group them by the author
        Group-Object GitUserEmail -NoElement |
        # sort them by count
        Sort-Object Count -Descending

Git.Log Example 4

    # Get all logs
    git log |
        # Group them by day of week
        Group-Object { $_.CommitDate.DayOfWeek } -NoElement

Git.Log Example 5

    # Get all logs
    git log |
        # where there is a pull request number
        Where-Object PullRequestNumber |
        # pick out the PullRequestNumber and CommitDate
        Select PullRequestNumber, CommitDate

Git.Log Example 6

Git.Mv Example 1

    git mv .\OldName.txt .\NewName.txt

Git.Mv Example 2

    git mv .\OldName.txt .\NewName.txt --verbose

Git.Pull Example 1

Git.Push Example 1

Git.RefLog Example 1

Git.Remote Example 1

Git.Remote Example 2

    git remote | git remote get-url

Git.Remote Example 3

    git remote | git remote show

Git.Rm Example 1

    git rm .\FileIDontCareAbout.txt

Git.Shortlog Example 1

    git shortlog  # Get a shortlog

Git.Shortlog Example 2

    git shortlog --email # Get a shortlog with email information

Git.Shortlog Example 3

    git shortlog --summary # Get a shortlog summary

Git.Shortlog Example 4

    git shortlog --sumary --email # Get a shortlog summary, with email.

Git.Sparse.Checkout.input Example 1

    git sparse-checkout -FileFilters *.ps1,*.psm1

Git.Stash Example 1

Git.Status Example 1

Git.Status Example 2

    git status | Select-Object -ExpandProperty Untracked

Git.SubModule.Status Example 1

Git.Worktree Example 1

Out-Git Extensions

Git Commands

Most extensions handle output from a single git command.

Additional Output Extensions

A few extensions handle output from any number of git commands, depending on the arguments.

Git.FileName

This applies to any git command that uses --name-only. It will attempt to return the name as a file, or as an object containing the name.

Git.FileOutput

This applies to an git command that uses the -o flag. It will attempt to locate any output specified by -o and return it as a file or directory.

Use-Git Extensions

ugit also allows you to extend the input for git.

What uses ugit?

ugit is part of the core of GitLogger.

GitLogger uses ugit to turn logs into objects and then provides standardized metrics and a way to query your logs.