Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
4 contributors

Users who have contributed to this file

@cinnamon-msft @carlos-zamora @glitchperfect @Summon528
77 lines (68 sloc) 7.49 KB

Profiles.json Documentation

Globals

Properties listed below affect the entire window, regardless of the profile settings.

Property Necessity Type Default Description
alwaysShowTabs Required Boolean true When set to true, tabs are always displayed. When set to false and showTabsInTitlebar is set to false, tabs only appear after typing Ctrl + T.
defaultProfile Required String PowerShell guid Sets the default profile. Opens by typing Ctrl + T or by clicking the '+' icon. The guid of the desired default profile is used as the value.
initialCols Required Integer 120 The number of columns displayed in the window upon first load.
initialRows Required Integer 30 The number of rows displayed in the window upon first load.
requestedTheme Required String system Sets the theme of the application. Possible values: "light", "dark", "system"
showTerminalTitleInTitlebar Required Boolean true When set to true, titlebar displays the title of the selected tab. When set to false, titlebar displays "Windows Terminal".
showTabsInTitlebar Optional Boolean true When set to true, the tabs are moved into the titlebar and the titlebar disappears. When set to false, the titlebar sits above the tabs.
wordDelimiters Optional String ` ./\()"'-:,.;<>~!@#$%^&* +=[]{}~?\u2502`

Profiles

Properties listed below are specific to each unique profile.

Property Necessity Type Default Description
acrylicOpacity Required Number 0.5 When useAcrylic is set to true, it sets the transparency of the window for the profile. Accepts floating point values from 0-1.
closeOnExit Required Boolean true When set to true, the selected tab closes when exit is typed. When set to false, the tab will remain open when exit is typed.
colorScheme Required String Campbell Name of the terminal color scheme to use. Color schemes are defined under schemes.
commandline Required String powershell.exe Executable used in the profile.
cursorColor Required String #FFFFFF Sets the cursor color for the profile. Uses hex color format: "#rrggbb".
cursorShape Required String bar Sets the cursor shape for the profile. Possible values: "vintage" ( ▃ ), "bar" ( ┃ ), "underscore" ( ▁ ), "filledBox" ( █ ), "emptyBox" ( ▯ )
fontFace Required String Consolas Name of the font face used in the profile.
fontSize Required Integer 10 Sets the font size.
guid Required String Unique identifier of the profile. Written in registry format: "{00000000-0000-0000-0000-000000000000}".
historySize Required Integer 9001 The number of lines above the ones displayed in the window you can scroll back to.
name Required String PowerShell Core Name of the profile. Displays in the dropdown menu.
padding Required String 0, 0, 0, 0 Sets the padding around the text within the window. Can have three different formats: "#" sets the same padding for all sides, "#, #" sets the same padding for left-right and top-bottom, and "#, #, #, #" sets the padding individually for left, top, right, and bottom.
snapOnInput Required Boolean true When set to true, the window will scroll to the command input line when typing. When set to false, the window will not scroll when you start typing.
startingDirectory Required String %USERPROFILE% The directory the shell starts in when it is loaded.
useAcrylic Required Boolean false When set to true, the window will have an acrylic background. When set to false, the window will have a plain, untextured background.
background Optional String Sets the background color of the profile. Overrides background set in color scheme if colorscheme is set. Uses hex color format: "#rrggbb".
colorTable Optional Array[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]
cursorHeight Optional Integer Sets the percentage height of the cursor starting from the bottom. Only works when cursorShape is set to "vintage". Accepts values from 25-100.
foreground Optional String Sets the foreground color of the profile. Overrides foreground set in color scheme if colorscheme is set. Uses hex color format: "#rrggbb".
icon Optional String Image file location of the icon used in the profile. Displays within the tab and the dropdown menu.
scrollbarState Optional String Defines the visibility of the scrollbar. Possible values: "visible", "hidden"
tabTitle Optional String Overrides default title of the tab.

Schemes

Properties listed below are specific to each color scheme. ColorTool is a great tool you can use to create and explore new color schemes. All colors use hex color format.

Property Necessity Type Description
name Required String Name of the color scheme.
foreground Required String Sets the foreground color of the color scheme.
background Required String Sets the background color of the color scheme.
black Required String Sets the color used as ANSI black.
blue Required String Sets the color used as ANSI blue.
brightBlack Required String Sets the color used as ANSI bright black.
brightBlue Required String Sets the color used as ANSI bright blue.
brightCyan Required String Sets the color used as ANSI bright cyan.
brightGreen Required String Sets the color used as ANSI bright green.
brightPurple Required String Sets the color used as ANSI bright purple.
brightRed Required String Sets the color used as ANSI bright red.
brightWhite Required String Sets the color used as ANSI bright white.
brightYellow Required String Sets the color used as ANSI bright yellow.
cyan Required String Sets the color used as ANSI cyan.
green Required String Sets the color used as ANSI green.
purple Required String Sets the color used as ANSI purple.
red Required String Sets the color used as ANSI red.
white Required String Sets the color used as ANSI white.
yellow Required String Sets the color used as ANSI yellow.

Keybindings

Properties listed below are specific to each custom key binding.

Property Necessity Type Description
command Required String The command executed when the associated key bindings are pressed.
keys Required Array[String] Defines the key combinations used to call the command.
You can’t perform that action at this time.