Skip to content

Get GitHubGitIgnore

Howard Wolosky edited this page Oct 5, 2020 · 1 revision

Get-GitHubGitIgnore

SYNOPSIS

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

SYNTAX

Get-GitHubGitIgnore [-Name <String>] [-RawContent] [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

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

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

EXAMPLES

EXAMPLE 1

Get-GitHubGitIgnore

Returns the list of all available .gitignore templates.

EXAMPLE 2

Get-GitHubGitIgnore -Name VisualStudio

Returns the content of the VisualStudio.gitignore template.

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

-Name

The name of the .gitignore template whose content should be fetched. Not providing this will cause a list of all available templates to be returned.

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

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

-RawContent

If specified, the raw content of the specified .gitignore file will be returned.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

[String]

OUTPUTS

GitHub.Gitignore

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally