command-palette.md

title	description	author	ms.author	ms.date	ms.topic	ms.localizationpriority
Windows Terminal Command Palette	Learn how to use the command palette in the Windows Terminal.	cinnamon-msft	cinnamon	11/11/2020	how-to	high

How to use the command palette in Windows Terminal

The command palette lets you see which actions you can run inside Windows Terminal. More information on how actions are defined can be found on the Actions page.

Invoking the command palette

You can invoke the command palette by typing Ctrl+Shift+P. This can be customized by adding the commandPalette command to your key bindings.

{ "command": "commandPalette", "keys": "ctrl+shift+p" }

Command line mode

If you'd like to enter a wt command into the command palette, you can do so by deleting the > character in the text box. This will run the wt command in the current window. More information on wt commands can be found on the Command line arguments page.

Adding an icon to a command

You can optionally add an icon to a command defined in your settings.json that appears in the command palette. This can be done by adding the icon property to the action. Icons can be a path to an image, a symbol from Segoe MDL2 Assets, or any character, including emojis.

{ "icon": "C:\\Images\\my-icon.png", "name": "New tab", "command": "newTab", "keys": "ctrl+shift+t" },
{ "icon": "\uE756", "name": "New tab", "command": "newTab", "keys": "ctrl+shift+t" },
{ "icon": "⚡", "name": "New tab", "command": "newTab", "keys": "ctrl+shift+t" }

Nested commands

Nested commands let you group multiple commands under one item in the command palette. The example below groups the font resize commands under one command palette item called "Change font size...".

{
    "name": "Change font size...",
    "commands": [
        { "command": { "action": "adjustFontSize", "delta": 1 } },
        { "command": { "action": "adjustFontSize", "delta": -1 } },
        { "command": "resetFontSize" },
    ]
}

Iterable commands

Iterable commands let you create multiple commands at the same time, generated from other objects defined in your settings. Currently, you can create iterable commands for your profiles and color schemes. At runtime, these commands will be expanded to one command for each of the objects of the given type.

You can currently iterate over the following properties:

iterateOn	Property	Property syntax
profiles	name	"name": "${profile.name}"
profiles	icon	"icon": "${profile.icon}"
schemes	name	"name": "${scheme.name}"

Example

Create a new tab command for each profile.

{
    "name": "New tab",
    "commands": [
        {
            "iterateOn": "profiles",
            "icon": "${profile.icon}",
            "name": "${profile.name}",
            "command": { "action": "newTab", "profile": "${profile.name}" }
        }
    ]
}

In the above example:

• "iterateOn": "profiles" will generate a command for each profile.
• At runtime, the terminal will replace ${profile.icon} with each profile's icon and ${profile.name} with each profile's name.

If you had three profiles:

"profiles": [
	{ "name": "Command Prompt", "icon": null },
	{ "name": "PowerShell", "icon": "C:\\path\\to\\icon.png" },
	{ "name": "Ubuntu", "icon": null },
]

The above command would behave like the following three commands:

{
    "name": "New tab...",
    "commands": [
        {
            "icon": null,
            "name": "Command Prompt",
            "command": { "action": "newTab", "profile": "Command Prompt" }
        },
        {
            "icon": "C:\\path\\to\\icon.png",
            "name": "PowerShell",
            "command": { "action": "newTab", "profile": "PowerShell" }
        },
        {
            "icon": null,
            "name": "Ubuntu",
            "command": { "action": "newTab", "profile": "Ubuntu" }
        }
    ]
}

Hiding a command

If you would like to keep a command in your key bindings list but not have it appear in the command palette, you can hide it by setting its name to null. The example below hides the "New tab" action from the command palette.

{ "name": null, "command": "newTab", "keys": "ctrl+shift+t" }