PowerShellForGitHub Module

Description

PowerShellForGitHub is a PowerShell module that provides command-line interaction and automation for the GitHub v3 API.

PowerShellForGitHub Cmdlets

Add-GitHubAssignee

Adds a list of assignees to a GitHub Issue for the given repository.

Add-GitHubGistStar

Star a gist from GitHub.

Add-GitHubIssueLabel

Adds a label to an issue in the given GitHub repository.

Backup-GitHubConfiguration

Exports the user's current configuration file.

Clear-GitHubAuthentication

Clears out any GitHub API token from memory, as well as from local file storage.

ConvertFrom-GitHubMarkdown

Converts arbitrary Markdown into HTML.

Copy-GitHubGist

Forks a gist from GitHub.

Disable-GitHubRepositorySecurityFix

Disables automated security fixes for a repository on GitHub.

Disable-GitHubRepositoryVulnerabilityAlert

Disables vulnerability alerts for a repository on GitHub.

Enable-GitHubRepositorySecurityFix

Enables automated security fixes for a repository on GitHub.

Enable-GitHubRepositoryVulnerabilityAlert

Enables vulnerability alerts for a repository on GitHub.

Get-GitHubAssignee

Lists the available assignees for issues in a repository.

Get-GitHubCloneTraffic

Get the total number of clones and breakdown per day or week for the last 14 days for the given GitHub Repository.

Get-GitHubCodeOfConduct

Gets Codes of Conduct or a specific Code of Conduct from GitHub.

Get-GitHubConfiguration

Gets the currently configured value for the requested configuration setting.

Get-GitHubContent

Retrieve the contents of a file or directory in a repository on GitHub.

Get-GitHubEmoji

Gets all the emojis available to use on GitHub.

Get-GitHubEvent

Lists events for an issue, repository, or a single event.

Get-GitHubGist

Retrieves gist information from GitHub.

Get-GitHubGistComment

Retrieves comments for a specific gist from GitHub.

Get-GitHubGitIgnore

Gets the list of available .gitignore templates, or their content, from GitHub.

Get-GitHubIssue

Retrieve Issues from GitHub.

Get-GitHubIssueComment

Get the Issue comments for a given GitHub repository.

Get-GitHubIssueTimeline

Retrieves various events that occur around an issue or pull request on GitHub.

Get-GitHubLabel

Retrieve label(s) of a given GitHub repository.

Get-GitHubLicense

Gets a license list or license content from GitHub.

Get-GitHubMilestone

Get the milestones for a given GitHub repository.

Get-GitHubOrganizationMember

Retrieve list of members within an organization.

Get-GitHubPathTraffic

Get the top 10 popular contents over the last 14 days for a given GitHub repository.

Get-GitHubProject

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

Get-GitHubProjectCard

Get the cards for a given GitHub Project Column.

Get-GitHubProjectColumn

Get the columns for a given GitHub Project.

Get-GitHubPullRequest

Retrieve the pull requests in the specified repository.

Get-GitHubRateLimit

Gets the current rate limit status for the GitHub API based on the currently configured authentication (Access Token).

Get-GitHubReaction

Retrieve reactions of a given GitHub Issue or Pull Request.

Get-GitHubReferrerTraffic

Get the top 10 referrers over the last 14 days for a given GitHub repository.

Get-GitHubRelease

Retrieves information about a release or list of releases on GitHub.

Get-GitHubReleaseAsset

Gets a a list of assets for a release, or downloads a single release asset.

Get-GitHubRepository

Retrieves information about a repository or list of repositories on GitHub.

Get-GitHubRepositoryBranch

Retrieve branches for a given GitHub repository.

Get-GitHubRepositoryBranchProtectionRule

Retrieve branch protection rules for a given GitHub repository.

Get-GitHubRepositoryCollaborator

Retrieve list of collaborators for a given repository.

Get-GitHubRepositoryContributor

Retrieve list of contributors for a given repository.

Get-GitHubRepositoryFork

Gets the list of forks of the specified repository on GitHub.

Get-GitHubRepositoryLanguage

Retrieves a list of the programming languages used in a repository on GitHub.

Get-GitHubRepositoryTag

Retrieves tags for a repository on GitHub.

Get-GitHubRepositoryTopic

Retrieves information about a repository on GitHub.

Get-GitHubTeam

Retrieve a team or teams within an organization or repository on GitHub.

Get-GitHubTeamMember

Retrieve list of team members within an organization.

Get-GitHubUser

Retrieves information about the specified user on GitHub.

Get-GitHubUserContextualInformation

Retrieves contextual information about the specified user on GitHub.

Get-GitHubViewTraffic

Get the total number of views and breakdown per day or week for the last 14 days for the given GitHub Repository.

Group-GitHubIssue

Groups the provided issues based on the specified grouping criteria.

Group-GitHubPullRequest

Groups the provided pull requests based on the specified grouping criteria.

Initialize-GitHubLabel

Replaces the entire set of Labels on the given GitHub repository to match the provided list of Labels.

Invoke-GHRestMethod

A wrapper around Invoke-WebRequest that understands the GitHub API.

Invoke-GHRestMethodMultipleResult

A special-case wrapper around Invoke-GHRestMethod that understands GET URI's which support the 'top' and 'max' parameters.

Join-GitHubUri

Combines the provided repository elements into a repository URL.

Lock-GitHubIssue

Lock an Issue or Pull Request conversation on GitHub.

Move-GitHubProjectCard

Move a GitHub Project Card.

Move-GitHubProjectColumn

Move a GitHub Project Column.

Move-GitHubRepositoryOwnership

Changes the ownership of a repository on GitHub.

New-GitHubGist

Creates a new gist on GitHub.

New-GitHubGistComment

Creates a new comment on the specified gist from GitHub.

New-GitHubIssue

Create a new Issue on GitHub.

New-GitHubIssueComment

Creates a new GitHub comment for an issue for the given repository.

New-GitHubLabel

Create a new label on a given GitHub repository.

New-GitHubMilestone

Creates a new GitHub milestone for the given repository.

New-GitHubProject

Creates a new GitHub project for the given repository.

New-GitHubProjectCard

Creates a new card for a GitHub project.

New-GitHubProjectColumn

Creates a new column for a GitHub project.

New-GitHubPullRequest

Create a new pull request in the specified repository.

New-GitHubRelease

Create a new release for a repository on GitHub.

New-GitHubReleaseAsset

Uploads a new asset for a release on GitHub.

New-GitHubRepository

Creates a new repository on GitHub.

New-GitHubRepositoryBranch

Creates a new branch for a given GitHub repository.

New-GitHubRepositoryBranchProtectionRule

Creates a branch protection rule for a branch on a given GitHub repository.

New-GitHubRepositoryFork

Creates a new fork of a repository on GitHub.

New-GitHubRepositoryFromTemplate

Creates a new repository on GitHub from a template repository.

New-GitHubTeam

Creates a team within an organization on GitHub.

Remove-GitHubAssignee

Removes an assignee from a GitHub issue.

Remove-GitHubGist

Removes/deletes a gist from GitHub.

Remove-GitHubGistComment

Removes/deletes a comment from a gist on GitHub.

Remove-GitHubGistFile

Removes one or more files from an existing gist on GitHub.

Remove-GitHubGistStar

Unstar a gist from GitHub.

Remove-GitHubIssueComment

Deletes a GitHub comment from an Issue in the given repository.

Remove-GitHubIssueLabel

Deletes a label from an issue in the given GitHub repository.

Remove-GitHubLabel

Deletes a label from a given GitHub repository.

Remove-GitHubMilestone

Deletes a GitHub milestone for the given repository.

Remove-GitHubProject

Removes the projects for a given GitHub repository.

Remove-GitHubProjectCard

Removes a project card.

Remove-GitHubProjectColumn

Removes the column for a project.

Remove-GitHubReaction

Removes a reaction on a given GitHub Issue or Pull Request.

Remove-GitHubRelease

Removes a release from a repository on GitHub.

Remove-GitHubReleaseAsset

Removes an asset from a release on GitHub.

Remove-GitHubRepository

Removes/deletes a repository from GitHub.

Remove-GitHubRepositoryBranch

Removes a branch from a given GitHub repository.

Remove-GitHubRepositoryBranchProtectionRule

Remove branch protection rules from a given GitHub repository.

Remove-GitHubTeam

Removes a team from an organization on GitHub.

Rename-GitHubGistFile

Renames a file in a gist on GitHub.

Rename-GitHubRepository

Rename a GitHub repository

Rename-GitHubTeam

Renames a team within an organization on GitHub.

Reset-GitHubConfiguration

Clears out the user's configuration file and configures this session with all default configuration values.

Restore-GitHubConfiguration

Sets the specified file to be the user's configuration file.

Set-GitHubAuthentication

Allows the user to configure the API token that should be used for authentication with the GitHub API.

Set-GitHubConfiguration

Change the value of a configuration property for the PowerShellForGitHub module, for the session only, or globally for this user.

Set-GitHubContent

Sets the contents of a file or directory in a repository on GitHub.

Set-GitHubGist

Updates a gist on GitHub.

Set-GitHubGistComment

Edits a comment on the specified gist from GitHub.

Set-GitHubGistFile

Updates content of file(s) in an existing gist on GitHub, or adds them if they aren't already part of the gist.

Set-GitHubGistStar

Changes the starred state of a gist on GitHub for the current authenticated user.

Set-GitHubIssue

Updates an Issue on GitHub.

Set-GitHubIssueComment

Modifies an existing comment in an issue for the given repository.

Set-GitHubIssueLabel

Replaces labels on an issue in the given GitHub repository.

Set-GitHubLabel

Updates an existing label on a given GitHub repository.

Set-GitHubMilestone

Update an existing milestone for the given repository.

Set-GitHubProfile

Updates profile information for the current authenticated user on GitHub.

Set-GitHubProject

Modify a GitHub Project.

Set-GitHubProjectCard

Modify a GitHub Project Card.

Set-GitHubProjectColumn

Modify a GitHub Project Column.

Set-GitHubReaction

Sets a reaction of a given GitHub Issue or Pull Request.

Set-GitHubRelease

Edits a release for a repository on GitHub.

Set-GitHubReleaseAsset

Edits an existing asset for a release on GitHub.

Set-GitHubRepository

Updates the details of an existing repository on GitHub.

Set-GitHubRepositoryTopic

Replaces all topics for a repository on GitHub.

Set-GitHubTeam

Updates a team within an organization on GitHub.

Split-GitHubUri

Extracts the relevant elements of a GitHub repository Uri and returns the requested element.

Test-GitHubAssignee

Checks if a user has permission to be assigned to an issue in this repository.

Test-GitHubAuthenticationConfigured

Indicates if a GitHub API Token has been configured for this module via Set-GitHubAuthentication.

Test-GitHubGistStar

Checks if a gist from GitHub is starred.

Test-GitHubOrganizationMember

Check to see if a user is a member of an organization.

Test-GitHubRepositoryVulnerabilityAlert

Retrieves the status of vulnerability alerts for a repository on GitHub.

Unlock-GitHubIssue

Unlocks an Issue or Pull Request conversation on GitHub.

Full Module Documentation