< Back
Set-MSTerminalProfile
Post
NAME Set-MSTerminalProfile
SYNOPSIS
Updates a profile setting.
SYNTAX
Set-MSTerminalProfile [-AcrylicOpacity <Single>] [-Background <String>] [-BackgroundImage <String>]
[-BackgroundImageAlignment {center | left | top | right | bottom | topLeft | topRight | bottomLeft | bottomRight}]
[-BackgroundImageOpacity <Double>] [-BackgroundImageStretchMode {none | fill | uniform | uniformToFill}] [-Clear
<String[]>] [-CloseOnExit] [-ColorScheme <String>] [-ColorTable <String[]>] [-CommandLine <String>] [-Confirm]
[-CursorColor <String>] [-CursorHeight <Int32>] [-CursorShape {bar | emptyBox | filledBox | underscore | vintage}]
[-ExtraSettings <Hashtable>] [-FontFace <String>] [-FontSize <Int32>] [-Foreground <String>] [-HistorySize
<Int32>] [-Icon <String>] -InputObject <Object> [-MakeDefault] [-Padding <Int32[]>] [-ScrollbarState {visible |
hidden}] [-SnapOnInput] [-StartingDirectory <String>] [-TabTitle <String>] [-UseAcrylic] [-WhatIf]
[<CommonParameters>]
Set-MSTerminalProfile [-AcrylicOpacity <Single>] [-Background <String>] [-BackgroundImage <String>]
[-BackgroundImageAlignment {center | left | top | right | bottom | topLeft | topRight | bottomLeft | bottomRight}]
[-BackgroundImageOpacity <Double>] [-BackgroundImageStretchMode {none | fill | uniform | uniformToFill}] [-Clear
<String[]>] [-CloseOnExit] [-ColorScheme <String>] [-ColorTable <String[]>] [-CommandLine <String>] [-Confirm]
[-CursorColor <String>] [-CursorHeight <Int32>] [-CursorShape {bar | emptyBox | filledBox | underscore | vintage}]
[-ExtraSettings <Hashtable>] [-FontFace <String>] [-FontSize <Int32>] [-Foreground <String>] [-HistorySize
<Int32>] [-Icon <String>] [-MakeDefault] -Name <String> [-Padding <Int32[]>] [-ScrollbarState {visible | hidden}]
[-SnapOnInput] [-StartingDirectory <String>] [-TabTitle <String>] [-UseAcrylic] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Updates a profile setting.
PARAMETERS
-AcrylicOpacity <Single>
Sets the acrylic opacity, 0 being completely transparent and 1 being completely opaque. This should be a
number between 0 and 1.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Background <String>
Sets the background color of the profile. Overrides "background" set in color scheme if "colorScheme" is set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImage <String>
The path to an image to use as the background for the terminal window. This value is ignored if UseAcrylic is
enabled.
Ex: "file:///c:/users/USER/Pictures/background.jpg"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageAlignment <String>
Sets how the background image aligns to the boundaries of the window.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageOpacity <Double>
The background image opacity, a number between 0 and 1.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageStretchMode <String>
How to resize the background image.
Fill - The background is resized to fill the window. The aspect ratio is not preserved. None - The background
image is kept at it's original dimensions. Uniform - The background image is resized to fill the window,
preserving the aspect ratio. UniformToFill - The background image is resized to fill the window, clipping the
image to make it fit the window and preserving the aspect ratio.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Clear <String[]>
A list of profile settings to remove from the profile. This takes precedence over any other value being set
by this cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloseOnExit [<SwitchParameter>]
Should MS Terminal close the tab when the program exits.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ColorScheme <String>
The name of the color scheme to use for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ColorTable <String[]>
Array of colors used in the profile if colorscheme is not set. Colors use hex color format: "#rrggbb".
Ordering is as follows: [black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red,
bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white]
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CommandLine <String>
The command line to run for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-CursorColor <String>
The cursor color in the format "#RRGGBB"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CursorHeight <Int32>
Sets the height of the cursor. Only works when "cursorShape" is set to "vintage". Accepts values from 25-100.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CursorShape <String>
The cursor shape.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExtraSettings <Hashtable>
A hashtable of additional settings to set in the profile. These entries are not validated and override other
parameter settings, use at your own risk!
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FontFace <String>
The name of the font to use for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FontSize <Int32>
The size of the font
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Foreground <String>
Sets the foreground color of the profile. Overrides foreground set in color scheme if colorscheme is set. Uses
hex color format: "#rrggbb".
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HistorySize <Int32>
The number of lines of history to store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Icon <String>
The icon to use for this profile. Ex: "ms-appdata:///roaming/console.ico"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <Object>
A profile object from Get-MSTerminalProfile that will be updated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-MakeDefault [<SwitchParameter>]
If specified, this profile will become the default profile.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the profile that will be updated.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Padding <Int32[]>
The padding to use between the window edges and the text.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ScrollbarState <String>
Defines the visibility of the scrollbar. Possible values: "visible", "hidden"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SnapOnInput [<SwitchParameter>]
Enable the SnapOnInput setting.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-StartingDirectory <String>
The working directory to start in.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TabTitle <String>
Overrides default title of the tab.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseAcrylic [<SwitchParameter>]
Enable acrylic effects.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
System.Object
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-MSTerminalProfile -Name pwsh -MakeDefault -FontSize 14
Updates the "pwsh" profile to be the default and sets the font size to 14.
RELATED LINKS
SYNOPSIS
Updates a profile setting.
SYNTAX
Set-MSTerminalProfile [-AcrylicOpacity <Single>] [-Background <String>] [-BackgroundImage <String>]
[-BackgroundImageAlignment {center | left | top | right | bottom | topLeft | topRight | bottomLeft | bottomRight}]
[-BackgroundImageOpacity <Double>] [-BackgroundImageStretchMode {none | fill | uniform | uniformToFill}] [-Clear
<String[]>] [-CloseOnExit] [-ColorScheme <String>] [-ColorTable <String[]>] [-CommandLine <String>] [-Confirm]
[-CursorColor <String>] [-CursorHeight <Int32>] [-CursorShape {bar | emptyBox | filledBox | underscore | vintage}]
[-ExtraSettings <Hashtable>] [-FontFace <String>] [-FontSize <Int32>] [-Foreground <String>] [-HistorySize
<Int32>] [-Icon <String>] -InputObject <Object> [-MakeDefault] [-Padding <Int32[]>] [-ScrollbarState {visible |
hidden}] [-SnapOnInput] [-StartingDirectory <String>] [-TabTitle <String>] [-UseAcrylic] [-WhatIf]
[<CommonParameters>]
Set-MSTerminalProfile [-AcrylicOpacity <Single>] [-Background <String>] [-BackgroundImage <String>]
[-BackgroundImageAlignment {center | left | top | right | bottom | topLeft | topRight | bottomLeft | bottomRight}]
[-BackgroundImageOpacity <Double>] [-BackgroundImageStretchMode {none | fill | uniform | uniformToFill}] [-Clear
<String[]>] [-CloseOnExit] [-ColorScheme <String>] [-ColorTable <String[]>] [-CommandLine <String>] [-Confirm]
[-CursorColor <String>] [-CursorHeight <Int32>] [-CursorShape {bar | emptyBox | filledBox | underscore | vintage}]
[-ExtraSettings <Hashtable>] [-FontFace <String>] [-FontSize <Int32>] [-Foreground <String>] [-HistorySize
<Int32>] [-Icon <String>] [-MakeDefault] -Name <String> [-Padding <Int32[]>] [-ScrollbarState {visible | hidden}]
[-SnapOnInput] [-StartingDirectory <String>] [-TabTitle <String>] [-UseAcrylic] [-WhatIf] [<CommonParameters>]
DESCRIPTION
Updates a profile setting.
PARAMETERS
-AcrylicOpacity <Single>
Sets the acrylic opacity, 0 being completely transparent and 1 being completely opaque. This should be a
number between 0 and 1.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Background <String>
Sets the background color of the profile. Overrides "background" set in color scheme if "colorScheme" is set.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImage <String>
The path to an image to use as the background for the terminal window. This value is ignored if UseAcrylic is
enabled.
Ex: "file:///c:/users/USER/Pictures/background.jpg"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageAlignment <String>
Sets how the background image aligns to the boundaries of the window.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageOpacity <Double>
The background image opacity, a number between 0 and 1.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackgroundImageStretchMode <String>
How to resize the background image.
Fill - The background is resized to fill the window. The aspect ratio is not preserved. None - The background
image is kept at it's original dimensions. Uniform - The background image is resized to fill the window,
preserving the aspect ratio. UniformToFill - The background image is resized to fill the window, clipping the
image to make it fit the window and preserving the aspect ratio.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Clear <String[]>
A list of profile settings to remove from the profile. This takes precedence over any other value being set
by this cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CloseOnExit [<SwitchParameter>]
Should MS Terminal close the tab when the program exits.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ColorScheme <String>
The name of the color scheme to use for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ColorTable <String[]>
Array of colors used in the profile if colorscheme is not set. Colors use hex color format: "#rrggbb".
Ordering is as follows: [black, red, green, yellow, blue, magenta, cyan, white, bright black, bright red,
bright green, bright yellow, bright blue, bright magenta, bright cyan, bright white]
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CommandLine <String>
The command line to run for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-CursorColor <String>
The cursor color in the format "#RRGGBB"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CursorHeight <Int32>
Sets the height of the cursor. Only works when "cursorShape" is set to "vintage". Accepts values from 25-100.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-CursorShape <String>
The cursor shape.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExtraSettings <Hashtable>
A hashtable of additional settings to set in the profile. These entries are not validated and override other
parameter settings, use at your own risk!
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FontFace <String>
The name of the font to use for this profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FontSize <Int32>
The size of the font
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Foreground <String>
Sets the foreground color of the profile. Overrides foreground set in color scheme if colorscheme is set. Uses
hex color format: "#rrggbb".
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-HistorySize <Int32>
The number of lines of history to store.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Icon <String>
The icon to use for this profile. Ex: "ms-appdata:///roaming/console.ico"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <Object>
A profile object from Get-MSTerminalProfile that will be updated.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-MakeDefault [<SwitchParameter>]
If specified, this profile will become the default profile.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the profile that will be updated.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Padding <Int32[]>
The padding to use between the window edges and the text.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ScrollbarState <String>
Defines the visibility of the scrollbar. Possible values: "visible", "hidden"
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SnapOnInput [<SwitchParameter>]
Enable the SnapOnInput setting.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-StartingDirectory <String>
The working directory to start in.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TabTitle <String>
Overrides default title of the tab.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-UseAcrylic [<SwitchParameter>]
Enable acrylic effects.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
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
System.Object
OUTPUTS
System.Object
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Set-MSTerminalProfile -Name pwsh -MakeDefault -FontSize 14
Updates the "pwsh" profile to be the default and sets the font size to 14.
RELATED LINKS