Test‑GitRemote

SYNOPSIS

Tests if a Git remote exists locally.

SYNTAX

Test-GitRemote [-Name] <String> [<CommonParameters>]

DESCRIPTION

The Test-GitRemote command checks if the specified Git remote exists locally and returns a boolean value indicating its existence.

EXAMPLES

EXAMPLE 1

Test-GitRemote -Name "origin"

Returns $true if the "origin" remote exists locally, otherwise returns $false.

PARAMETERS

-Name

Specifies the name of the Git remote to be tested.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

None

This function does not accept pipeline input.

OUTPUTS

System.Boolean

Returns $true if the remote exists, otherwise $false.

NOTES

This function requires Git to be installed and accessible from the command line.

RELATED LINKS