Get GitHubRepository - X-Guardian/PowerShellForGitHub GitHub Wiki
Retrieves information about a repository or list of repositories on GitHub.
Get-GitHubRepository [-Visibility <String>] [-Affiliation <String[]>] [-Type <String>] [-Sort <String>]
[-Direction <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubRepository [-OwnerName <String>] [-RepositoryName <String>] [-Type <String>] [-Sort <String>]
[-Direction <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubRepository -Uri <String> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Get-GitHubRepository [-OrganizationName <String>] [-Type <String>] [-Sort <String>] [-Direction <String>]
[-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubRepository [-GetAllPublicRepositories] [-Since <Int64>] [-AccessToken <String>] [-NoStatus] [-WhatIf]
[-Confirm] [<CommonParameters>]
Retrieves information about a repository or list of repositories on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
Get-GitHubRepository
Gets all repositories for the current authenticated user.
Get-GitHubRepository -GetAllPublicRepositories
Gets all public repositories on GitHub.
Get-GitHubRepository -OwnerName octocat
Gets all of the repositories for the user octocat
Get-GitHubUser -UserName octocat | Get-GitHubRepository
Gets all of the repositories for the user octocat
Get-GitHubRepository -Uri https://github.com/microsoft/PowerShellForGitHub
Gets information about the microsoft/PowerShellForGitHub repository.
$repo | Get-GitHubRepository
You can pipe in a previous repository to get its refreshed information.
Get-GitHubRepository -OrganizationName PowerShell
Gets all of the repositories in the PowerShell organization.
If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCan be one or more of:
owner - Repositories that are owned by the authenticated user
collaborator - Repositories that the user has been added to as a collaborator
organization_member - Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
Type: System.String[]
Parameter Sets: AuthenticatedUser
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDirection of the sort that is to be applied to the results.
Type: System.String
Parameter Sets: AuthenticatedUser, ElementsOrUser, Organization
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf this is specified with no other parameter, then instead of returning back all repositories for the current authenticated user, it will instead return back all public repositories on GitHub in the order in which they were created.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: PublicRepos
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf this switch is specified, long-running commands will run on the main thread with no commandline status update. When not specified, those commands run in the background, enabling the command prompt to provide status information. If not supplied here, the DefaultNoStatus configuration property value will be used.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the organization to retrieve the repositories for.
Type: System.String
Parameter Sets: Organization
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseOwner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.
Type: System.String
Parameter Sets: ElementsOrUser
Aliases: UserName
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.
Type: System.String
Parameter Sets: ElementsOrUser
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe ID of the last public repository that you have seen. If specified with -GetAllPublicRepositories, will only return back public repositories created after this one.
Type: System.Int64
Parameter Sets: PublicRepos
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseProperty that the results should be sorted by
Type: System.String
Parameter Sets: AuthenticatedUser, ElementsOrUser, Organization
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe type of repository to return.
Type: System.String
Parameter Sets: AuthenticatedUser, ElementsOrUser, Organization
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.
Type: System.String
Parameter Sets: Uri
Aliases: RepositoryUrl
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe type of visibility/accessibility for the repositories to return.
Type: System.String
Parameter Sets: AuthenticatedUser
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.