Skip to content

Latest commit

 

History

History
115 lines (77 loc) · 2.21 KB

Set-ConsoleTitle.md

File metadata and controls

115 lines (77 loc) · 2.21 KB
external help file Module Name online version schema
PSScriptTools-help.xml
PSScriptTools
2.0.0

Set-ConsoleTitle

SYNOPSIS

Set the console title text.

SYNTAX

Set-ConsoleTitle [-Title] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Use this command to modify the text displayed in the title bar of your PowerShell console window. This command is intended for use in a traditional PowerShell console. It will not work in consoles that are part of the PowerShell ISE or Visual Studio Code. It should work in a PowerShell session running in Windows Terminal.

EXAMPLES

Example 1

PS C:\> Set-ConsoleTitle $env:computername

Set the console title to the computer name.

Example 2

PS C:\> if (Test-IsAdministrator) {
    Set-ConsoleTitle "Admin: PS $($PSVersionTable.PSVersion)"
    }

Modify the console title if running as Administrator

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-Title

Enter the title for the console window.

Type: String
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None

OUTPUTS

None

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Set-ConsoleColor