Command Line Configuration Extensions. Add Command Line Метод

Определение

Перегрузки

Добавляет IConfigurationProvider, считывающий значения конфигурации из командной строки. Adds an IConfigurationProvider that reads configuration values from the command line.

Добавляет CommandLineConfigurationProviderIConfigurationProvider, считывающий значения конфигурации из командной строки. Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line.

Добавляет CommandLineConfigurationProviderIConfigurationProvider, считывающий значения конфигурации из командной строки с использованием указанных сопоставлений переключений. Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line using the specified switch mappings.

AddCommandLine(IConfigurationBuilder, Action )

Добавляет IConfigurationProvider, считывающий значения конфигурации из командной строки. Adds an IConfigurationProvider that reads configuration values from the command line.

Параметры

Объект IConfigurationBuilder, в который необходимо выполнить добавление. The IConfigurationBuilder to add to.

Настраивает источник. Configures the source.

Возвращаемое значение

Применяется к

AddCommandLine(IConfigurationBuilder, String[])

Добавляет CommandLineConfigurationProviderIConfigurationProvider, считывающий значения конфигурации из командной строки. Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line.

Параметры

Объект IConfigurationBuilder, в который необходимо выполнить добавление. The IConfigurationBuilder to add to.

Аргументы командной строки. The command line args.

Возвращаемое значение

Примеры

Простое консольное приложение, имеющее пять значений. A simple console application that has five values.

Комментарии

Значения, передаваемые в командной строке, в массиве строк args , должны быть набором ключей с двумя дефисами («—«), а затем значениями, раздельными по знаку равенства («=») или пробелам («»). The values passed on the command line, in the args string array, should be a set of keys prefixed with two dashes («—«) and then values, separate by either the equals sign («=») or a space (» «).

Косую черту («/») можно использовать в качестве альтернативного префикса с либо с равной, либо с пробелом, а также при использовании знака равенства префикс можно полностью оставить. A forward slash («/») can be used as an alternative prefix, with either equals or space, and when using an equals sign the prefix can be left out altogether.

Существует пять основных альтернативных форматов для аргументов: Key1 = value1—key2 = value2/Key3 = значение3—Key4 value4/key5 value5 . There are five basic alternative formats for arguments: key1=value1 —key2=value2 /key3=value3 —key4 value4 /key5 value5 .

Применяется к

AddCommandLine(IConfigurationBuilder, String[], IDictionary )

Добавляет CommandLineConfigurationProviderIConfigurationProvider, считывающий значения конфигурации из командной строки с использованием указанных сопоставлений переключений. Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line using the specified switch mappings.

Параметры

Объект IConfigurationBuilder, в который необходимо выполнить добавление. The IConfigurationBuilder to add to.

Аргументы командной строки. The command line args.

Сопоставления переключений. The switch mappings. Словарь коротких ключей (с префиксом «-«) и ключей псевдонимов (с префиксом «—«), сопоставленных с ключом конфигурации (без префикса). A dictionary of short (with prefix «-«) and alias keys (with prefix «—«), mapped to the configuration key (no prefix).

Возвращаемое значение

Примеры

Простое консольное приложение с двумя короткими и четырьмя сопоставлениями переключателей псевдонимов. A simple console application that has two short and four alias switch mappings defined.

Комментарии

Свитчмаппингс позволяет использовать дополнительные форматы для альтернативных коротких и псевдонимов клавиш из командной строки. The switchMappings allows additional formats for alternative short and alias keys to be used from the command line. См. также базовую версию аддкоммандлине для поддерживаемых стандартных форматов. Also see the basic version of AddCommandLine for the standard formats supported.

Короткие ключи начинаются с одиночного тире («-«) и сопоставляются с именем основного ключа (без префикса) и могут использоваться с либо с равно, либо с пробелом. Short keys start with a single dash («-«) and are mapped to the main key name (without prefix), and can be used with either equals or space. Сопоставления одного тире предназначены для более коротких альтернативных параметров. The single dash mappings are intended to be used for shorter alternative switches.

Обратите внимание, что невозможно напрямую получить доступ к одному параметру тире, но необходимо определить сопоставление коммутатора и получить доступ с помощью полного ключа. Note that a single dash switch cannot be accessed directly, but must have a switch mapping defined and accessed using the full key. Передача неопределенного однопунктирного аргумента будет вызываться как FormatException . Passing an undefined single dash argument will cause as FormatException .

Для коротких аргументов существует два формата: -K1 = значение1-априорной оценкой K2 value2 . There are two formats for short arguments: -k1=value1 -k2 value2 .

Определения ключей псевдонимов начинаются с двух дефисов («—«) и сопоставляются с именем основного ключа (без префикса) и могут использоваться вместо обычного ключа. Alias key definitions start with two dashes («—«) and are mapped to the main key name (without prefix), and can be used in place of the normal key. Они также работают при использовании префикса косой черты в командной строке (но не в формате префикса «не равно»). They also work when a forward slash prefix is used in the command line (but not with the no prefix equals format).

Есть только четыре формата для аргументов с псевдонимами: —alt3 = значение3/alt4 = value4—alt5 value5/alt6 value6 . There are only four formats for aliased arguments: —alt3=value3 /alt4=value4 —alt5 value5 /alt6 value6 .

Using command line arguments for Windows Terminal

You can use wt.exe to open a new instance of Windows Terminal from the command line. You can also use the execution alias wt instead.

If you built Windows Terminal from the source code on GitHub, you can open that build using wtd.exe or wtd .

Command line syntax

The wt command line accepts two types of values: options and commands. Options are a list of flags and other parameters that can control the behavior of the wt command line as a whole. Commands provide the action, or list of actions separated by semicolons, that should be implemented. If no command is specified, then the command is assumed to be new-tab by default.

To display a help message listing the available command line arguments, enter: wt -h , wt —help , wt -? , or wt /? .

Options and commands

Below is the full list of supported commands and options for the wt command line.

Option	Description
—help , -h , -? , /?	Displays the help message.
—maximized , -M	Launches the terminal maximized.
—fullscreen , -F	Launches the terminal as full screen.
—focus , -f	Launches the terminal in the focus mode. Can be combined with maximized .
—window , -w	Launches the terminal in a specific window.

Command	Parameters	Description
new-tab , nt	—profile, -p profile-name , —startingDirectory, -d starting-directory , commandline , —title , —tabColor	Creates a new tab.
split-pane , sp	-H, —horizontal , -V, —vertical , —profile, -p profile-name , —startingDirectory, -d starting-directory , —title , —tabColor , —size, -s size , commandline , -D, —duplicate	Splits a new pane.
focus-tab , ft	—target, -t tab-index	Focuses on a specific tab.
move-focus , mf	direction	Move focus between panes in the given direction. Accepts one of up , down , left , right .

When opening Windows Terminal from cmd (Command Prompt), if you want to use your custom «cmd» profile settings, you will need to use the command wt -p cmd . Otherwise, to run your default profile settings, just use wt cmd .

The -D, —duplicate parameter for split-pane is only available in Windows Terminal Preview.

Command line argument examples

Commands may vary slightly depending on which command line you’re using.

Target a specific window

The ability for the —window,-w parameter to accept window names is only available in Windows Terminal Preview.

Below are examples of how to target specific windows using the —window,-w option.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running.

Open a new profile instance

To open a new terminal instance, in this case the command will open the profile named «Ubuntu-18.04», enter:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running.

The -p flag is used to specify the Windows Terminal profile that should be opened. Substitute «Ubuntu-18.04» with the name of any terminal profile that you have installed. This will always open a new window. Windows Terminal is not yet capable of opening new tabs or panes in an existing instance.

Target a directory

To specify the folder that should be used as the starting directory for the console, in this case the d:\ directory, enter:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running.

Multiple tabs

To open a new terminal instance with multiple tabs, enter:

PowerShell uses a semicolon ; to delimit statements. To interpret a semicolon ; as a command delimiter for wt command-line arguments, you need to escape semicolon characters using backticks. PowerShell also has the stop parsing operator (—%), which instructs it to stop interpreting anything after it and just pass it on verbatim.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running.

To open a new terminal instance with multiple tabs, in this case a Command Prompt profile and a PowerShell profile, enter:

PowerShell uses a semicolon ; to delimit statements. To interpret a semicolon ; as a command delimiter for wt command-line arguments, you need to escape semicolon characters using backticks. PowerShell also has the stop parsing operator (—%), which instructs it to stop interpreting anything after it and just pass it on verbatim.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; backslash + semicolon separates commands.

Multiple panes

To open a new terminal instance with one tab containing three panes running a Command Prompt profile, a PowerShell profile, and your default profile running a WSL command line, enter:

PowerShell uses a semicolon ; to delimit statements. To interpret a semicolon ; as a command delimiter for wt command-line arguments, you need to escape semicolon characters using backticks. PowerShell also has the stop parsing operator (—%), which instructs it to stop interpreting anything after it and just pass it on verbatim.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; backslash + semicolon separates commands.

The -H flag (or —horizontal ) indicates that you would like the panes to be split horizontally. The -V flag (or —vertical ) indicates that you would like the panes split vertically.

Multiple tabs and panes

The new-tab and split-pane commands can be sequenced to get multiple tabs, each with split panes. To open a new terminal instance with two tabs, each with two panes running a Command Prompt and a WSL command line, with each tab in a different directory, enter:

PowerShell uses a semicolon ; to delimit statements. To interpret a semicolon ; as a command delimiter for wt command-line arguments, you need to escape semicolon characters using backticks. PowerShell also has the stop parsing operator (—%), which instructs it to stop interpreting anything after it and just pass it on verbatim.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; backslash + semicolon separates commands. Note to specify a Windows directory as the starting directory for wsl.exe that two backslashes \\ are required.

Tab title

To open a new terminal instance with custom tab titles, use the —title argument. To set the title of each tab when opening two tabs, enter:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; forward-slash + semicolon separates commands.

Using application title (Preview)

To open a new terminal instance allowing applications within it to set the tab title by sending title change messages, use the —useApplicationTitle flag. To suppress these messages, use the —suppressApplicationTitle flag. If none of these flags are provided, the behavior is inherited from the profile’s settings. To open a tab with title tabname that will not be overridden by the application, enter:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; backslash + semicolon separates commands.

This feature is only available in Windows Terminal Preview.

Tab color

To open a new terminal instance with custom tab colors, use the —tabColor argument. This argument overrides the value defined in the profile, but can be overridden as well using the tab color picker. In the following example, a new terminal is created with two tabs of different colors:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and \; separates commands.

When —tabColor is set for a tab, it is associated with the first pane of this tab. Hence in a tab with multiple panes, the color will be applied only if the first pane is in focus. To set the tab color for additional panes, you will need to add the —tabColor parameter to the split-pane subcommand as well. In the example below, a tab with two panes is created with tab colors specified for each pane:

Color scheme (Preview)

To open a new terminal instance with a specific color scheme (instead of the colorScheme set in the profile), use the —colorScheme argument. This argument overrides the value defined in the profile.

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and \; separates commands.

This feature is only available in Windows Terminal Preview.

Tab focus

To open a new terminal instance with a specific tab in focus, use the -t flag (or —target ), along with the tab-index number. To open your default profile in the first tab and the «Ubuntu-18.04» profile focused in the second tab ( -t 1 ), enter:

Execution aliases do not work in WSL distributions. If you want to use wt.exe from a WSL command line, you can spawn it from CMD directly by running cmd.exe . The /c option tells CMD to terminate after running and the \; backslash + semicolon separates commands.

Examples of multiple commands from PowerShell

Windows Terminal uses the semicolon character ; as a delimiter for separating commands in the wt command line. Unfortunately, PowerShell also uses ; as a command separator. To work around this, you can use the following tricks to run multiple wt commands from PowerShell. In all the following examples, a new terminal window is created with three panes — one running Command Prompt, one with PowerShell, and the last one running WSL.

The following examples use the Start-Process command to run wt . For more information on why the terminal uses Start-Process , see Using start below.

Single quoted parameters

In this example, the wt parameters are wrapped in single quotes ( ‘ ). This syntax is useful if nothing is being calculated.

Escaped quotes

When passing a value contained in a variable to the wt command line, use the following syntax:

Note the usage of ` to escape the double-quotes ( » ) around «Windows PowerShell» in the -p parameter to the split-pane parameter.

Using start

All the above examples explicitly used start to launch the terminal.

The following examples do not use start to run the command line. Instead, there are two other methods of escaping the command line:

• Only escaping the semicolons so that PowerShell will ignore them and pass them straight to wt .
• Using —% , so PowerShell will treat the rest of the command line as arguments to the application.

In both of these examples, the newly created Windows Terminal window will create the window by correctly parsing all the provided command-line arguments.

However, these methods are not recommended currently, as PowerShell will wait for the newly-created terminal window to be closed before returning control to PowerShell. By default, PowerShell will always wait for Windows Store applications (like Windows Terminal) to close before returning to the prompt. Note that this is different than the behavior of Command Prompt, which will return to the prompt immediately.