Skip to content

Add PSProfileCommandAlias

Nate Ferrell edited this page Sep 8, 2019 · 2 revisions

Add-PSProfileCommandAlias

SYNOPSIS

Adds a command alias to your PSProfile configuration to set during PSProfile import.

SYNTAX

Add-PSProfileCommandAlias [-Alias] <String> [-Command] <String> [-Force] [-Save] [<CommonParameters>]

DESCRIPTION

Adds a command alias to your PSProfile configuration to set during PSProfile import.

EXAMPLES

EXAMPLE 1

Add-PSProfileCommandAlias -Alias code -Command Open-Code -Save

Adds the command alias 'code' targeting the command 'Open-Code' and saves your PSProfile configuration.

PARAMETERS

-Alias

The alias to set for the command.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Command

The name of the command to set the alias for.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

If the alias already exists in $PSProfile.CommandAliases, use -Force to overwrite the existing value.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Save

If $true, saves the updated PSProfile after updating.

Type: 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

OUTPUTS

NOTES

RELATED LINKS

PSProfile

Concepts

Function Help

Command Aliases

Configuration

Helpers

Init Scripts

Meta

Modules to Import

Modules to Install

Path Aliases

Plugin Paths

Plugins

Power Tools

Project Paths

Prompts

Script Paths

Secrets

Symbolic Links

Variables

Badges

Azure Pipelines      Discord - Chat      Slack - Chat      Codacy PowerShell Gallery      GitHub Releases      GitHub Releases

Clone this wiki locally