< Back
Get-GitHubGitIgnore
Post
NAME Get-GitHubGitIgnore
SYNOPSIS
Gets the list of available .gitignore templates, or their content, from GitHub.
SYNTAX
Get-GitHubGitIgnore [[-Name] <String>] [[-AccessToken] <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<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
PARAMETERS
-Name <String>
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.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
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.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoStatus [<SwitchParameter>]
If this switch is specified, long-running commands will run on the main thread
with no commandline 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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GitHubGitIgnore
Returns the list of all available .gitignore templates.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GitHubGitIgnore -Name VisualStudio
Returns the content of the VisualStudio.gitignore template.
RELATED LINKS
SYNOPSIS
Gets the list of available .gitignore templates, or their content, from GitHub.
SYNTAX
Get-GitHubGitIgnore [[-Name] <String>] [[-AccessToken] <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<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
PARAMETERS
-Name <String>
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.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
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.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoStatus [<SwitchParameter>]
If this switch is specified, long-running commands will run on the main thread
with no commandline 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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-GitHubGitIgnore
Returns the list of all available .gitignore templates.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-GitHubGitIgnore -Name VisualStudio
Returns the content of the VisualStudio.gitignore template.
RELATED LINKS