Home - X-Guardian/PowerShellForGitHub GitHub Wiki

PowerShellForGitHub Module

Description

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

PowerShellForGitHub Cmdlets

Add-GitHubAssignee

Add-GitHubIssueLabel

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.

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

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-GitHubComment

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

Get-GitHubGitIgnore

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

Get-GitHubIssue

Retrieve Issues from GitHub.

Get-GitHubIssueComment

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-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-GitHubProjectCard

Get-GitHubProjectColumn

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-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-GitHubRepository

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

Get-GitHubRepositoryBranch

Retrieve branches 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 Store 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-GitHubProjectColumn

Move-GitHubRepositoryOwnership

Changes the ownership of a repository on GitHub.

New-GitHubComment

New-GitHubIssue

Create a new Issue on GitHub.

New-GitHubIssueComment

New-GitHubLabel

Create a new label on a given GitHub repository.

New-GitHubMilestone

New-GitHubProject

New-GitHubProjectCard

New-GitHubProjectColumn

New-GitHubPullRequest

Create a new pull request in the specified repository.

New-GitHubRepository

Creates a new repository on GitHub.

New-GitHubRepositoryFork

Creates a new fork of a repository on GitHub.

New-GitHubRepositoryFromTemplate

Creates a new repository on GitHub from a template repository.

Remove-GitHubAssignee

Remove-GitHubComment

Remove-GitHubIssueComment

Remove-GitHubIssueLabel

Remove-GitHubLabel

Deletes a label from a given GitHub repository.

Remove-GitHubMilestone

Remove-GitHubProject

Remove-GitHubProjectCard

Remove-GitHubProjectColumn

Remove-GitHubRepository

Removes/deletes a repository from GitHub.

Rename-GitHubRepository

Rename a GitHub repository

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-GitHubComment

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-GitHubIssue

Updates an Issue on GitHub.

Set-GitHubIssueComment

Set-GitHubIssueLabel

Set-GitHubLabel

Updates an existing label on a given GitHub repository.

Set-GitHubMilestone

Set-GitHubProfile

Updates profile information for the current authenticated user on GitHub.

Set-GitHubProject

Set-GitHubProjectCard

Set-GitHubProjectColumn

Set-GitHubRepository

Updates the details of an existing repository on GitHub.

Set-GitHubRepositoryTopic

Replaces all topics for a repository on GitHub.

Split-GitHubUri

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

Test-GitHubAssignee

Test-GitHubAuthenticationConfigured

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

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.