Get GitHubProject - X-Guardian/PowerShellForGitHub GitHub Wiki

Get-GitHubProject

SYNOPSIS

SYNTAX

Elements (Default)

Get-GitHubProject -OwnerName <String> -RepositoryName <String> [-State <String>] [-AccessToken <String>]
 [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]

ProjectObject

Get-GitHubProject -Uri <String> -Project <Int64> [-State <String>] [-AccessToken <String>] [-NoStatus]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Uri

Get-GitHubProject -Uri <String> [-State <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Organization

Get-GitHubProject -OrganizationName <String> [-State <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf]
 [-Confirm] [<CommonParameters>]

User

Get-GitHubProject -UserName <String> [-State <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Project

Get-GitHubProject -Project <Int64> [-State <String>] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Get the projects for a given GitHub user, repository or organization.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Get-GitHubProject -OwnerName microsoft -RepositoryName PowerShellForGitHub

Get the projects for the microsoft\PowerShellForGitHub repository.

EXAMPLE 2

Get-GitHubProject -OrganizationName Microsoft

Get the projects for the Microsoft organization.

EXAMPLE 3

Get-GitHubProject -Uri https://github.com/Microsoft/PowerShellForGitHub

Get the projects for the microsoft\PowerShellForGitHub repository using the Uri.

EXAMPLE 4

Get-GitHubProject -UserName GitHubUser

Get the projects for the user GitHubUser.

EXAMPLE 5

Get-GitHubProject -OwnerName microsoft -RepositoryName PowerShellForGitHub -State Closed

Get closed projects from the microsoft\PowerShellForGitHub repo.

EXAMPLE 6

Get-GitHubProject -Project 4378613

Get a project by id, with this parameter you don't need any other information.

PARAMETERS

-AccessToken

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: False

-NoStatus

If this switch is specified, long-running commands will run on the main thread with no command line 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: False

-OrganizationName

The name of the organization to get projects for.

Type: System.String
Parameter Sets: Organization
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Project

ID of the project to retrieve.

Type: System.Int64
Parameter Sets: ProjectObject
Aliases: ProjectId

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: System.Int64
Parameter Sets: Project
Aliases: ProjectId

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-State

Only projects with this state are returned.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: ProjectObject, Uri
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserName

The name of the user to get projects for.

Type: System.String
Parameter Sets: User
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts 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: False

-WhatIf

Shows 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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Release

GitHub.Repository

OUTPUTS

GitHub.Project

NOTES

RELATED LINKS

⚠️ **GitHub.com Fallback** ⚠️