How to Use Profiles in Windows PowerShell ISE

This article explains how to use Profiles in Windows PowerShellВ® Integrated Scripting Environment (ISE). We recommend that before performing the tasks in this section, you review about_Profiles, or in the Console Pane, type, Get-Help about_Profiles and press ENTER .

A profile is a Windows PowerShell ISE script that runs automatically when you start a new session. You can create one or more Windows PowerShell profiles for Windows PowerShell ISE and use them to add the configure the Windows PowerShell or Windows PowerShell ISE environment, preparing it for your use, with variables, aliases, functions, and color and font preferences that you want available. A profile affects every Windows PowerShell ISE session that you start.

The Windows PowerShell execution policy determines whether you can run scripts and load a profile. The default execution policy, «Restricted,» prevents all scripts from running, including profiles. If you use the «Restricted» policy, the profile cannot load. For more information about execution policy, see about_Execution_Policies.

Selecting a profile to use in the Windows PowerShell ISE

Windows PowerShell ISE supports profiles for the current user and all users. It also supports the Windows PowerShell profiles that apply to all hosts.

The profile that you use is determined by how you use Windows PowerShell and Windows PowerShell ISE.

If you use only Windows PowerShell ISE to run Windows PowerShell, then save all your items in one of the ISE-specific profiles, such as the CurrentUserCurrentHost profile for Windows PowerShell ISE or the AllUsersCurrentHost profile for Windows PowerShell ISE.

If you use multiple host programs to run Windows PowerShell, save your functions, aliases, variables, and commands in a profile that affects all host programs, such as the CurrentUserAllHosts or the AllUsersAllHosts profile, and save ISE-specific features, like color and font customization in the CurrentUserCurrentHost profile for Windows PowerShell ISE profile or the AllUsersCurrentHost profile for Windows PowerShell ISE.

The following are profiles that can be created and used in Windows PowerShell ISE. Each profile is saved to its own specific path.

Profile Type	Profile Path
Current user, PowerShell ISE	$PROFILE.CurrentUserCurrentHost , or $PROFILE
All users, PowerShell ISE	$PROFILE.AllUsersCurrentHost
Current user, All hosts	$PROFILE.CurrentUserAllHosts
All users, All hosts	$PROFILE.AllUsersAllHosts

To create a new profile

To create a new «Current user, Windows PowerShell ISE» profile, run this command:

To create a new «All users, Windows PowerShell ISE» profile, run this command:

To create a new «Current user, All Hosts» profile, run this command:

To create a new «All users, All Hosts» profile, type:

To edit a profile

To open the profile, run the command psEdit with the variable that specifies the profile you want to edit. For example, to open the «Current user, Windows PowerShell ISE» profile, type: psEdit $PROFILE

Add some items to your profile. The following are a few examples to get you started:

To change the default background color of the Console Pane to blue, in the profile file type: $psISE.Options.OutputPaneBackground = ‘blue’ . For more information about the $psISE variable, see Windows PowerShell ISE Object Model Reference.

To change font size to 20, in the profile file type: $psISE.Options.FontSize =20

To save your profile file, on the File menu, click Save. Next time you open the Windows PowerShell ISE, your customizations are applied.

About Profiles

Short Description

Describes how to create and use a PowerShell profile.

Long Description

You can create a PowerShell profile to customize your environment and to add session-specific elements to every PowerShell session that you start.

A PowerShell profile is a script that runs when PowerShell starts. You can use the profile as a logon script to customize the environment. You can add commands, aliases, functions, variables, snap-ins, modules, and PowerShell drives. You can also add other session-specific elements to your profile so they are available in every session without having to import or re-create them.

PowerShell supports several profiles for users and host programs. However, it does not create the profiles for you. This topic describes the profiles, and it describes how to create and maintain profiles on your computer.

It explains how to use the NoProfile parameter of the PowerShell console (PowerShell.exe) to start PowerShell without any profiles. And, it explains the effect of the PowerShell execution policy on profiles.

The Profile Files

PowerShell supports several profile files. Also, PowerShell host programs can support their own host-specific profiles.

For example, the PowerShell console supports the following basic profile files. The profiles are listed in precedence order. The first profile has the highest precedence.

Description	Path
All Users, All Hosts	$PSHOME\Profile.ps1
All Users, Current Host	$PSHOME\Microsoft.PowerShell_profile.ps1
Current User, All Hosts	$Home\[My ]Documents\PowerShell\Profile.ps1
Current user, Current Host	$Home\[My ]Documents\PowerShell\ Microsoft.PowerShell_profile.ps1

The profile paths include the following variables:

• The $PSHOME variable, which stores the installation directory for PowerShell
• The $Home variable, which stores the current user’s home directory

In addition, other programs that host PowerShell can support their own profiles. For example, Visual Studio Code supports the following host-specific profiles.

Description	Path
All users, Current Host	$PSHOME\Microsoft.VSCode_profile.ps1
Current user, Current Host	$Home\[My ]Documents\PowerShell\ Microsoft.VSCode_profile.ps1

In PowerShell Help, the «CurrentUser, Current Host» profile is the profile most often referred to as «your PowerShell profile».

The $PROFILE variable

The $PROFILE automatic variable stores the paths to the PowerShell profiles that are available in the current session.

To view a profile path, display the value of the $PROFILE variable. You can also use the $PROFILE variable in a command to represent a path.

The $PROFILE variable stores the path to the «Current User, Current Host» profile. The other profiles are saved in note properties of the $PROFILE variable.

For example, the $PROFILE variable has the following values in the Windows PowerShell console.

Description	Name
Current User, Current Host	$PROFILE
Current User, Current Host	$PROFILE.CurrentUserCurrentHost
Current User, All Hosts	$PROFILE.CurrentUserAllHosts
All Users, Current Host	$PROFILE.AllUsersCurrentHost
All Users, All Hosts	$PROFILE.AllUsersAllHosts

Because the values of the $PROFILE variable change for each user and in each host application, ensure that you display the values of the profile variables in each PowerShell host application that you use.

To see the current values of the $PROFILE variable, type:

You can use the $PROFILE variable in many commands. For example, the following command opens the «Current User, Current Host» profile in Notepad:

The following command determines whether an «All Users, All Hosts» profile has been created on the local computer:

How to create a profile

To create a PowerShell profile, use the following command format:

For example, to create a profile for the current user in the current PowerShell host application, use the following command:

In this command, the If statement prevents you from overwriting an existing profile. Replace the value of the

placeholder with the path to the profile file that you want to create.

To create «All Users» profiles in Windows Vista and later versions of Windows, start PowerShell with the Run as administrator option.

How to edit a profile

You can open any PowerShell profile in a text editor, such as Notepad.

To open the profile of the current user in the current PowerShell host application in Notepad, type:

To open other profiles, specify the profile name. For example, to open the profile for all the users of all the host applications, type:

To apply the changes, save the profile file, and then restart PowerShell.

How to choose a profile

If you use multiple host applications, put the items that you use in all the host applications into your $PROFILE.CurrentUserAllHosts profile. Put items that are specific to a host application, such as a command that sets the background color for a host application, in a profile that is specific to that host application.

If you are an administrator who is customizing PowerShell for many users, follow these guidelines:

• Store the common items in the $PROFILE.AllUsersAllHosts profile
• Store items that are specific to a host application in $PROFILE.AllUsersCurrentHost profiles that are specific to the host application
• Store items for particular users in the user-specific profiles

Be sure to check the host application documentation for any special implementation of PowerShell profiles.

How to use a profile

Many of the items that you create in PowerShell and most commands that you run affect only the current session. When you end the session, the items are deleted.

The session-specific commands and items include variables, preference variables, aliases, functions, commands (except for Set-ExecutionPolicy), and PowerShell modules that you add to the session.

To save these items and make them available in all future sessions, add them to a PowerShell profile.

Another common use for profiles is to save frequently-used functions, aliases, and variables. When you save the items in a profile, you can use them in any applicable session without recreating them.

How to start a profile

When you open the profile file, it is blank. However, you can fill it with the variables, aliases, and commands that you use frequently.

Here are a few suggestions to get you started.

Add commands that make it easy to open your profile

This is especially useful if you use a profile other than the «Current User, Current Host» profile. For example, add the following command:

Add a function that lists the aliases for any cmdlet

Customize your console

Add a customized PowerShell prompt

For more information about the PowerShell prompt, see about_Prompts.

The NoProfile parameter

To start PowerShell without profiles, use the NoProfile parameter of PowerShell.exe, the program that starts PowerShell.

To begin, open a program that can start PowerShell, such as Cmd.exe or PowerShell itself. You can also use the Run dialog box in Windows.

For a complete list of the parameters of PowerShell.exe, type:

Profiles and Execution Policy

The PowerShell execution policy determines, in part, whether you can run scripts and load configuration files, including the profiles. The Restricted execution policy is the default. It prevents all scripts from running, including the profiles. If you use the «Restricted» policy, the profile does not run, and its contents are not applied.

A Set-ExecutionPolicy command sets and changes your execution policy. It is one of the few commands that applies in all PowerShell sessions because the value is saved in the registry. You do not have to set it when you open the console, and you do not have to store a Set-ExecutionPolicy command in your profile.

Profiles and remote sessions

PowerShell profiles are not run automatically in remote sessions, so the commands that the profiles add are not present in the remote session. In addition, the $PROFILE automatic variable is not populated in remote sessions.

To run a profile in a session, use the Invoke-Command cmdlet.

For example, the following command runs the «Current user, Current Host» profile from the local computer in the session in $s .

The following command runs the «Current user, Current Host» profile from the remote computer in the session in $s . Because the $PROFILE variable is not populated, the command uses the explicit path to the profile. We use dot sourcing operator so that the profile executes in the current scope on the remote computer and not in its own scope.

After running this command, the commands that the profile adds to the session are available in $s .

Использование профилей в интегрированной среде сценариев Windows PowerShell How to Use Profiles in Windows PowerShell ISE

В этой статье описывается, как использовать профили в интегрированной среде скриптов Windows PowerShell®. This article explains how to use Profiles in Windows PowerShell® Integrated Scripting Environment (ISE). Перед выполнением задач из этого раздела рекомендуется ознакомиться со статьей about_Profiles либо в области консоли ввести Get-Help about_Profiles и нажать клавишу ВВОД . We recommend that before performing the tasks in this section, you review about_Profiles, or in the Console Pane, type, Get-Help about_Profiles and press ENTER .

Профиль — это сценарий интегрированной среды сценариев Windows PowerShell, который выполняется автоматически при запуске нового сеанса. A profile is a Windows PowerShell ISE script that runs automatically when you start a new session. Можно создать один или несколько профилей Windows PowerShell для интегрированной среды сценариев Windows PowerShell и использовать их для настройки среды Windows PowerShell для интегрированной среды сценариев Windows PowerShell, подготавливая ее к работе с помощью переменных, псевдонимов, функций, а также настроек цветов и шрифтов, которые должны быть доступны. You can create one or more Windows PowerShell profiles for Windows PowerShell ISE and use them to add the configure the Windows PowerShell or Windows PowerShell ISE environment, preparing it for your use, with variables, aliases, functions, and color and font preferences that you want available. Профиль затрагивает каждый запускаемый сеанс интегрированной среды сценариев Windows PowerShell. A profile affects every Windows PowerShell ISE session that you start.

Политика выполнения Windows PowerShell определяет, можно ли запускать сценарии и загружать профиль. The Windows PowerShell execution policy determines whether you can run scripts and load a profile. Политика выполнения по умолчанию (Restricted) запрещает выполнение всех сценариев, включая профили. The default execution policy, «Restricted,» prevents all scripts from running, including profiles. При использовании политики Restricted загрузить профиль нельзя. If you use the «Restricted» policy, the profile cannot load. Дополнительные сведения о политике выполнения см. в статье about_Execution_Policies. For more information about execution policy, see about_Execution_Policies.

Выбор профиля для использования в интегрированной среде сценариев Windows PowerShell Selecting a profile to use in the Windows PowerShell ISE

Интегрированная среда сценариев Windows PowerShell поддерживает профили для текущего пользователя и для всех пользователей. Windows PowerShell ISE supports profiles for the current user and all users. Он также поддерживает профили Windows PowerShell, затрагивающие все узлы. It also supports the Windows PowerShell profiles that apply to all hosts.

Выбор профиля зависит от того, каким образом вы используете Windows PowerShell и интегрированную среду сценариев Windows PowerShell. The profile that you use is determined by how you use Windows PowerShell and Windows PowerShell ISE.

Если для запуска Windows PowerShell используется только интегрированная среда сценариев Windows PowerShell, сохраните все элементы в одном из профилей интегрированной среды сценариев, таком как CurrentUserCurrentHost или AllUsersCurrentHost для интегрированной среды сценариев Windows PowerShell. If you use only Windows PowerShell ISE to run Windows PowerShell, then save all your items in one of the ISE-specific profiles, such as the CurrentUserCurrentHost profile for Windows PowerShell ISE or the AllUsersCurrentHost profile for Windows PowerShell ISE.

Если для запуска Windows PowerShell используется несколько основных программ, сохраните свои функции, псевдонимы, переменные и команды в профиле, затрагивающем все основные программы, таком как CurrentUserAllHosts или AllUsersAllHosts , и сохраните функции интегрированной среды сценариев, такие как настройки цветов и шрифтов, в профиле CurrentUserCurrentHost или AllUsersCurrentHost для интегрированной среды сценариев Windows PowerShell. If you use multiple host programs to run Windows PowerShell, save your functions, aliases, variables, and commands in a profile that affects all host programs, such as the CurrentUserAllHosts or the AllUsersAllHosts profile, and save ISE-specific features, like color and font customization in the CurrentUserCurrentHost profile for Windows PowerShell ISE profile or the AllUsersCurrentHost profile for Windows PowerShell ISE.

Ниже указаны профили, которые можно создать и использовать в интегрированной среде сценариев Windows PowerShell. The following are profiles that can be created and used in Windows PowerShell ISE. Каждый профиль сохраняется по собственному пути. Each profile is saved to its own specific path.

Тип профиля Profile Type	Путь к профилю Profile Path
Текущий пользователь, интегрированная среда сценариев PowerShell Current user, PowerShell ISE	$PROFILE.CurrentUserCurrentHost или $PROFILE $PROFILE.CurrentUserCurrentHost , or $PROFILE
Все пользователи, интегрированная среда сценариев PowerShell All users, PowerShell ISE	$PROFILE.AllUsersCurrentHost
Текущий пользователь, все узлы Current user, All hosts	$PROFILE.CurrentUserAllHosts
Все пользователи, все узлы All users, All hosts	$PROFILE.AllUsersAllHosts

Создание профиля To create a new profile

Для создания профиля «Текущий пользователь, интегрированная среда сценариев PowerShell» выполните следующую команду: To create a new «Current user, Windows PowerShell ISE» profile, run this command:

Для создания профиля «Все пользователи, интегрированная среда сценариев PowerShell» выполните следующую команду: To create a new «All users, Windows PowerShell ISE» profile, run this command:

Для создания профиля «Текущий пользователь, все узлы» выполните следующую команду: To create a new «Current user, All Hosts» profile, run this command:

Для создания профиля «Все пользователи, все узлы» введите следующее: To create a new «All users, All Hosts» profile, type:

Изменение профиля To edit a profile

Чтобы открыть профиль, запустите команду psEdit с переменной, которая указывает изменяемый профиль. To open the profile, run the command psEdit with the variable that specifies the profile you want to edit. Например, для открытия профиля «Текущий пользователь, интегрированная среда сценариев PowerShell» введите: psEdit $PROFILE For example, to open the «Current user, Windows PowerShell ISE» profile, type: psEdit $PROFILE

Добавьте несколько элементов в профиль. Add some items to your profile. Ниже приведено несколько примеров, как можно приступить к работе: The following are a few examples to get you started:

Чтобы изменить цвет фона по умолчанию для области консоли на синий, введите в файле профиля следующее: $psISE.Options.OutputPaneBackground = ‘blue’ . To change the default background color of the Console Pane to blue, in the profile file type: $psISE.Options.OutputPaneBackground = ‘blue’ . Дополнительные сведения о переменной $psISE см. в справочнике по объектной модели интегрированной среды сценариев Windows PowerShell. For more information about the $psISE variable, see Windows PowerShell ISE Object Model Reference.

Чтобы изменить размер шрифта на 20, введите в файле профиля следующее: $psISE.Options.FontSize =20 To change font size to 20, in the profile file type: $psISE.Options.FontSize =20

Чтобы сохранить файл профиля, в меню Файл щелкните Сохранить. To save your profile file, on the File menu, click Save. Внесенные изменения применяются при следующем открытии интегрированной среды сценариев Windows PowerShell. Next time you open the Windows PowerShell ISE, your customizations are applied.