Get-GitHubRepository¶
SYNOPSIS¶
Gets a specific repository or list of repositories.
SYNTAX¶
List repositories for the authenticated user (Default)¶
Get-GitHubRepository [-Visibility <string>] [-Affiliation <string[]>] [-Property <string[]>]
[-AdditionalProperty <string[]>] [-PerPage <int>] [-Context <Object>] [<CommonParameters>]
List repositories for a team¶
Get-GitHubRepository -Owner <string> -Team <string> [-Property <string[]>]
[-AdditionalProperty <string[]>] [-Context <Object>] [<CommonParameters>]
Get the repository and permission for the specified team¶
Get-GitHubRepository -Owner <string> -Name <string> -Team <string> [-Property <string[]>]
[-AdditionalProperty <string[]>] [-Context <Object>] [<CommonParameters>]
List repositories from an account¶
Get-GitHubRepository -Owner <string> [-Visibility <string>] [-Affiliation <string[]>]
[-Property <string[]>] [-AdditionalProperty <string[]>] [-PerPage <int>] [-Context <Object>]
[<CommonParameters>]
Get a repository by name¶
Get-GitHubRepository -Owner <string> -Name <string> [-Property <string[]>]
[-AdditionalProperty <string[]>] [-Context <Object>] [<CommonParameters>]
Get a repository for the authenticated user by name¶
Get-GitHubRepository -Name <string> [-Property <string[]>] [-AdditionalProperty <string[]>]
[-Context <Object>] [<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION¶
Gets a specific repository or list of repositories. If no parameters are specified, the authenticated user's repositories are returned. If a username is specified, the user's public repositories are returned. If an organization is specified, the organization's public repositories are returned. Can also be used with the name parameter to get a specific repository.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubRepository
Gets the repositories for the authenticated user.
EXAMPLE 2¶
Get-GitHubRepository -Username 'octocat'
Gets the repositories for the specified user.
EXAMPLE 3¶
Get-GitHubRepository -Organization 'github' -Name 'octocat'
Gets the specified repository.
EXAMPLE 4¶
Get-GitHubRepository -Organization 'github' -Team 'my-team'
Gets repositories that the 'my-team' team has access to in the github organization.
EXAMPLE 5¶
Get-GitHubRepository -Organization 'github' -Name 'octocat' -Team 'my-team'
Gets the repository and permission for the my-team team on the octocat repository in the github organization.
PARAMETERS¶
-AdditionalProperty¶
Additional properties to include in the returned object. Is added to the list of properties to include. This is useful for properties that are not included in the default list of properties.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Affiliation¶
Limit the results to repositories where the user has this role.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List repositories from an account
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: List repositories for the authenticated user
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Context¶
The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.
Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Name¶
The name of the repository without the .git extension. The name is not case sensitive.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Get the repository and permission for the specified team
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: Get a repository for the authenticated user by name
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: Get a repository by name
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Owner¶
The account owner of the repository. The name is not case sensitive.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Organization
- Username
ParameterSets:
- Name: List repositories for a team
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: Get the repository and permission for the specified team
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: List repositories from an account
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: Get a repository by name
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-PerPage¶
The number of results per page (max 100).
Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List repositories from an account
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: List repositories for the authenticated user
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Property¶
Properties to include in the returned object.
Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Team¶
The slug of the team.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List repositories for a team
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: Get the repository and permission for the specified team
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Visibility¶
Limit the results to repositories with a visibility level.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: List repositories from an account
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
- Name: List repositories for the authenticated user
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
GitHubOwner¶
{{ Fill in the Description }}
System.String¶
{{ Fill in the Description }}
OUTPUTS¶
GithubRepository¶
{{ Fill in the Description }}
GitHubRepository¶
{{ Fill in the Description }}