Find-GitRepository

Searches a directory and its parents for a Git repository.

Syntax

Find-GitRepository [[-Path] <String>] [-Verify] [<CommonParameters>]

Description

The Find-GitRepository function searches a directory for a Git repository and returns a LibGit2Sharp.Repository object representing that repository. If a repository isn't found, it looks up the directory tree until it finds one (i.e. it looks at the directories parent directory, then that directory's parent, then that directory's parent, etc. until it finds a repository or gets to the root directory. If it doesn't find one, nothing is returned.

With no parameters, looks in the current directory and up its directory tree. If given a path with the Path parameter, it looks in that directory then up its directory tree.

The repository object that is returned contains resources that don't get automatically removed from memory by .NET. To avoid memory leaks, you must call its Dispose() method when you're done using it.

Parameters

Name Type Description Required? Pipeline Input Default Value
Path String

The path to start searching.

false false (Get-Location).ProviderPath
Verify SwitchParameter

Write an error if a repository isn't found. Usually, no error is written and nothing is returned when a repository isn't found.

false false False

Return Values

LibGit2Sharp.Repository.

EXAMPLE 1

Find-GitRepository

Demonstrates how to find the Git repository of the current directory.

EXAMPLE 2

Find-GitRepository -Path 'C:\Projects\LibGit2.PowerShell\LibGit2\bin'

Demonstrates how to find the Git repository that a specific directory is a part of. In this case, a LibGit2Sharp.Repository object is returned for the repository at C:\Projects\LibGit2.PowerShell.