< Back
Get-RepoInfo
Post
NAME Get-RepoInfo
SYNOPSIS
Gets an object describing the full details of a repo based on its name and hosting service.
SYNTAX
Get-RepoInfo [-Repo] <String> [[-Service] <String>] [[-Path] <String>] [<CommonParameters>]
DESCRIPTION
Generates an object which includes information about a repo including its expected location on
your local filesystem, the webpage on which it may be viewed, the URL which should be used by
a git clone operation and more.
PARAMETERS
-Repo <String>
The name of the repository which you would like to describe.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Service <String>
The remote hosting provider for the repository in question.
Required? false
Position? 2
Default value $GitTool.Service
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
The directory within which all of your repositories are stored. Defaults to the value of $GitTool.Directory
if not specified.
Required? false
Position? 3
Default value $GitTool.Directory
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RepoInfo sierrasoftworks/git-tool
Name Value
---- -----
WebURL https://github.com/SierraSoftworks/git-tool
Service github.com
Repo SierraSoftworks/git-tool
Path C:\\dev\\github.com\\SierraSoftworks\\git-tool
Exists True
GitURL git@github.com:SierraSoftworks/git-tool.git
RELATED LINKS
SYNOPSIS
Gets an object describing the full details of a repo based on its name and hosting service.
SYNTAX
Get-RepoInfo [-Repo] <String> [[-Service] <String>] [[-Path] <String>] [<CommonParameters>]
DESCRIPTION
Generates an object which includes information about a repo including its expected location on
your local filesystem, the webpage on which it may be viewed, the URL which should be used by
a git clone operation and more.
PARAMETERS
-Repo <String>
The name of the repository which you would like to describe.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Service <String>
The remote hosting provider for the repository in question.
Required? false
Position? 2
Default value $GitTool.Service
Accept pipeline input? false
Accept wildcard characters? false
-Path <String>
The directory within which all of your repositories are stored. Defaults to the value of $GitTool.Directory
if not specified.
Required? false
Position? 3
Default value $GitTool.Directory
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-RepoInfo sierrasoftworks/git-tool
Name Value
---- -----
WebURL https://github.com/SierraSoftworks/git-tool
Service github.com
Repo SierraSoftworks/git-tool
Path C:\\dev\\github.com\\SierraSoftworks\\git-tool
Exists True
GitURL git@github.com:SierraSoftworks/git-tool.git
RELATED LINKS