diff --git a/reference/docfx.json b/reference/docfx.json index 29cd27e8e36..8488878a967 100644 --- a/reference/docfx.json +++ b/reference/docfx.json @@ -56,7 +56,6 @@ "docs-conceptual/samples/**/*.md": "sample", "docs-conceptual/whats-new/**/*.md": "whats-new", "docs-conceptual/windows-powershell/ise/*.md": "ui-reference", - "docs-conceptual/windows-powershell/ise/object-model/*.md": "reference" }, "ms.update-cycle": { "docs-conceptual/community/*-updates.md": "1825-days", @@ -71,7 +70,19 @@ "docs-conceptual/samples/**": "3650-days", "docs-conceptual/security/remoting/jea/**": "3650-days", "docs-conceptual/whats-new/**": "1825-days", - "docs-conceptual/windows-powershell/**": "3650-days" + "docs-conceptual/windows-powershell/**": "3650-days", + + "index.yml": "1825-days", + "docs-conceptual/discover-powershell.md": "1825-days", + "docs-conceptual/overview.md": "1825-days", + "docs-conceptual/powershell-commands.md": "1825-days", + "docs-conceptual/what-is-a-command-shell.md": "1825-days", + "docs-conceptual/what-is-windows-powershell.md": "1825-days", + "docs-conceptual/community/community-support.md": "1825-days", + "docs-conceptual/learn/glossary.md": "1825-days", + "docs-conceptual/install/installing-powershell.yml": "1825-days", + "docs-conceptual/security/overview.yml": "1825-days", + "module/index.md": "1825-days" }, "products": { "5.1/**/*": [ diff --git a/reference/docs-conceptual/install/PowerShell-in-Docker.md b/reference/docs-conceptual/install/PowerShell-in-Docker.md index 34c8b602469..1c11131b96d 100644 --- a/reference/docs-conceptual/install/PowerShell-in-Docker.md +++ b/reference/docs-conceptual/install/PowerShell-in-Docker.md @@ -1,6 +1,6 @@ --- description: How to use PowerShell in a Docker image. -ms.date: 03/11/2025 +ms.date: 11/21/2025 ms.devlang: powershell title: Use PowerShell in Docker --- diff --git a/reference/docs-conceptual/install/PowerShell-on-ARM.md b/reference/docs-conceptual/install/PowerShell-on-ARM.md index dc73f9f6707..cfb7a9e3959 100644 --- a/reference/docs-conceptual/install/PowerShell-on-ARM.md +++ b/reference/docs-conceptual/install/PowerShell-on-ARM.md @@ -1,6 +1,6 @@ --- description: PowerShell on Arm-based systems -ms.date: 08/28/2024 +ms.date: 11/21/2025 title: PowerShell on Arm-based systems --- @@ -13,17 +13,16 @@ the versions that have been tested. It may be possible to use Arm-based versions of PowerShell on other Linux distributions and versions, but we don't officially support it. -## PowerShell 7.4 +## PowerShell 7 -Arm versions of PowerShell 7.4 can be installed on the following platforms: +Arm versions of PowerShell 7 can be installed on the following platforms: | OS | Architectures | Lifecycle | | -------------------------------- | ------------- | -------------------------------------- | | Windows 11 Client Version 22000+ | Arm64 | [Windows][05] | -| Windows 10 Client Version 1607+ | Arm64 | [Windows][05] | | macOS | Arm64 | [macOS][04] | | Raspberry Pi OS (Debian 12) | Arm32 | [Raspberry Pi OS][08] and [Debian][06] | -| Ubuntu 22.04, 20.04 | Arm32 | [Ubuntu][07] | +| Ubuntu 22.04 | Arm32 | [Ubuntu][07] | Support is based on the [.NET 8.0 Supported OS Lifecycle Policy][03]. @@ -33,9 +32,8 @@ For installation instructions, see the following articles: Windows -- [Windows 10 on Arm][13] -- [Windows 10 IoT Enterprise][12] -- [Windows 10 IoT Core][11] +- [Windows 11 on Arm][13] +- [Windows 11 IoT][11] Linux - install from the binary archives @@ -58,7 +56,6 @@ Raspberry Pi [07]: https://wiki.ubuntu.com/Releases [08]: https://www.raspberrypi.com/software/operating-systems/ [09]: install-other-linux.md#binary-archives -[10]: installing-powershell-on-macos.md -[11]: installing-powershell-on-windows.md#deploying-on-windows-10-iot-core -[12]: installing-powershell-on-windows.md#deploying-on-windows-10-iot-enterprise -[13]: installing-powershell-on-windows.md#installing-the-zip-package +[10]: install-powershell-on-macos.md +[11]: install-powershell-on-windows-iot-nano.md#deploy-on-windows-11-iot +[13]: install-powershell-on-windows.md#zip diff --git a/reference/docs-conceptual/install/install-powershell-on-linux.md b/reference/docs-conceptual/install/install-powershell-on-linux.md index 68f006d2308..36fa0117965 100644 --- a/reference/docs-conceptual/install/install-powershell-on-linux.md +++ b/reference/docs-conceptual/install/install-powershell-on-linux.md @@ -1,6 +1,6 @@ --- description: This article lists the Linux distributions and package managers that are supported for installing PowerShell. -ms.date: 01/09/2023 +ms.date: 11/21/2025 title: Install PowerShell on Linux --- # Install PowerShell on Linux diff --git a/reference/docs-conceptual/install/microsoft-update-faq.yml b/reference/docs-conceptual/install/microsoft-update-faq.yml index 3c13557bede..386807981cf 100644 --- a/reference/docs-conceptual/install/microsoft-update-faq.yml +++ b/reference/docs-conceptual/install/microsoft-update-faq.yml @@ -1,6 +1,6 @@ ### YamlMime:FAQ metadata: - ms.date: 02/20/2025 + ms.date: 11/21/2025 title: Microsoft Update for PowerShell FAQ description: Frequently asked questions about the using Microsoft Update to update PowerShell ms.topic: faq diff --git a/reference/docs-conceptual/learn/experimental-features.md b/reference/docs-conceptual/learn/experimental-features.md index c99632fc7b3..6ad5366e60d 100644 --- a/reference/docs-conceptual/learn/experimental-features.md +++ b/reference/docs-conceptual/learn/experimental-features.md @@ -1,6 +1,6 @@ --- description: Lists the currently available experimental features and how to use them. -ms.date: 01/23/2025 +ms.date: 11/21/2025 title: Using Experimental Features in PowerShell --- # Using Experimental Features in PowerShell @@ -33,15 +33,14 @@ Get-ExperimentalFeature ``` ```Output -Name Enabled Source Description ----- ------- ------ ----------- -PSCommandNotFoundSuggestion False PSEngine Recommend potential commands based on fuzzy searc… -PSCommandWithArgs False PSEngine Enable `-CommandWithArgs` parameter for pwsh -PSFeedbackProvider True PSEngine Replace the hard-coded suggestion framework with … -PSLoadAssemblyFromNativeCode False PSEngine Expose an API to allow assembly loading from nati… -PSModuleAutoLoadSkipOfflineFiles True PSEngine Module discovery will skip over files that are ma… -PSSerializeJSONLongEnumAsNumber True PSEngine Serialize enums based on long or ulong as an nume… -PSSubsystemPluginModel True PSEngine A plugin model for registering and un-registering… +Name Enabled Source Description +---- ------- ------ ----------- +PSFeedbackProvider True PSEngine Replace the hard-coded suggestion framework with the extensible feedb… +PSLoadAssemblyFromNativeCode False PSEngine Expose an API to allow assembly loading from native code +PSNativeWindowsTildeExpansion True PSEngine On windows, expand unquoted tilde (`~`) with the user's current home … +PSRedirectToVariable True PSEngine Add support for redirecting to the variable drive +PSSerializeJSONLongEnumAsNumber True PSEngine Serialize enums based on long or ulong as an numeric value rather tha… +PSSubsystemPluginModel True PSEngine A plugin model for registering and un-registering PowerShell subsyste… ``` Use the [Enable-ExperimentalFeature][18] and [Disable-ExperimentalFeature][17] cmdlets to enable or @@ -49,7 +48,7 @@ disable a feature. You must start a new PowerShell session for this change to be following command to enable the `PSCommandNotFoundSuggestion` feature: ```powershell -Enable-ExperimentalFeature PSCommandNotFoundSuggestion +Enable-ExperimentalFeature PSFeedbackProvider ``` ```Output @@ -85,15 +84,15 @@ Legend | Name | 7.4 | 7.5 | 7.6 (preview) | | --------------------------------------------------- | :-----------------: | :-----------------: | :-----------------: | | [PSCommandNotFoundSuggestion][06] | ![Experimental][02] | ![Mainstream][01] | ![Mainstream][01] | +| [PSCommandWithArgs][07] | ![Experimental][02] | ![Mainstream][01] | ![Mainstream][01] | | [PSDesiredStateConfiguration.InvokeDscResource][08] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | -| [PSSubsystemPluginModel][15] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | -| [PSLoadAssemblyFromNativeCode][10] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | | [PSFeedbackProvider][09] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | +| [PSLoadAssemblyFromNativeCode][10] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | | [PSModuleAutoLoadSkipOfflineFiles][11] | ![Experimental][02] | ![Mainstream][01] | ![Mainstream][01] | -| [PSCommandWithArgs][07] | ![Experimental][02] | ![Mainstream][01] | ![Mainstream][01] | | [PSNativeWindowsTildeExpansion][12] | | ![Experimental][02] | ![Experimental][02] | | [PSRedirectToVariable][13] | | ![Experimental][02] | ![Experimental][02] | | [PSSerializeJSONLongEnumAsNumber][14] | | ![Experimental][02] | ![Experimental][02] | +| [PSSubsystemPluginModel][15] | ![Experimental][02] | ![Experimental][02] | ![Experimental][02] | ### PSCommandNotFoundSuggestion diff --git a/reference/docs-conceptual/learn/more-powershell-learning.md b/reference/docs-conceptual/learn/more-powershell-learning.md index a09006238c8..49fc6d84556 100644 --- a/reference/docs-conceptual/learn/more-powershell-learning.md +++ b/reference/docs-conceptual/learn/more-powershell-learning.md @@ -1,61 +1,61 @@ --- description: A list of resources for learning PowerShell and connecting with other PowerShell users. -ms.date: 08/18/2022 +ms.date: 11/21/2025 title: PowerShell learning resources --- # PowerShell learning resources Additional resources for learning about PowerShell. -## Learn modules +## Learn training modules Microsoft Learn is a free, online training platform that provides interactive learning for Microsoft products and more. Our goal is to help you become proficient on our technologies and learn more skills with fun, guided, hands-on, interactive content that's specific to your role and goals. -- [PowerShell modules][1] +- [PowerShell training][10] ## Blogs and community In addition to the Help available at the command line, the following resources provide more information for users who want to run PowerShell. -- [PowerShell Team Blog][2]. The best resource for learning directly from the PowerShell product +- [PowerShell Team Blog][12]. The best resource for learning directly from the PowerShell product team. -- [PowerShell Community Blog][3] articles are scenario-driven. Written by the community, for the +- [PowerShell Community Blog][11] articles are scenario-driven. Written by the community, for the community. - Have questions about using PowerShell? Connect with hundreds of other people who have similar - interests in one of the many community forums listed on the [PowerShell Community][4] page. + interests in one of the many community forums listed on the [PowerShell Community][02] page. ### Microsoft Virtual Academy The Microsoft Virtual Academy videos have been moved to Channel 9. -- [Getting Started with Microsoft PowerShell][5] -- [Advanced Tools & Scripting with PowerShell 3.0 Jump Start][6] -- [Testing PowerShell with Pester][7] -- [Getting Started with PowerShell Desired State Configuration (DSC)][8] -- [Advanced PowerShell DSC and Custom Resources][9] -- [SharePoint Automation with DSC][10] +- [Getting Started with Microsoft PowerShell][06] +- [Advanced Tools & Scripting with PowerShell 3.0 Jump Start][05] +- [Testing PowerShell with Pester][09] +- [Getting Started with PowerShell Desired State Configuration (DSC)][07] +- [Advanced PowerShell DSC and Custom Resources][04] +- [SharePoint Automation with DSC][08] ## Resources for PowerShell Developers The following resources provide resources to help developers create their own PowerShell modules, functions, cmdlets, providers, and hosting applications. -- [PowerShell SDK][11] -- [PowerShell SDK API Browser][12] +- [PowerShell SDK][03] +- [PowerShell SDK API Browser][01] -[1]: /training/browse/?terms=PowerShell -[2]: https://devblogs.microsoft.com/powershell/ -[3]: https://devblogs.microsoft.com/powershell-community/ -[4]: /powershell/scripting/community/community-support -[5]: /shows/getting-started-with-microsoft-powershell/ -[6]: /shows/advanced-tools-and-scripting-with-powershell-3.0-jump-start/ -[7]: /shows/testing-powershell-with-pester/ -[8]: /shows/getting-started-with-powershell-dsc/ -[9]: /shows/advanced-powershell-dsc-and-custom-resources/ -[10]: /shows/sharepoint-automation-with-dsc/ -[11]: /powershell/scripting/developer/windows-powershell -[12]: /dotnet/api/system.management.automation +[01]: /dotnet/api/system.management.automation +[02]: /powershell/scripting/community/community-support +[03]: /powershell/scripting/developer/windows-powershell +[04]: /shows/advanced-powershell-dsc-and-custom-resources/ +[05]: /shows/advanced-tools-and-scripting-with-powershell-3.0-jump-start/ +[06]: /shows/getting-started-with-microsoft-powershell/ +[07]: /shows/getting-started-with-powershell-dsc/ +[08]: /shows/sharepoint-automation-with-dsc/ +[09]: /shows/testing-powershell-with-pester/ +[10]: /training/browse/?terms=PowerShell +[11]: https://devblogs.microsoft.com/powershell-community/ +[12]: https://devblogs.microsoft.com/powershell/ diff --git a/reference/docs-conceptual/learn/shell/creating-profiles.md b/reference/docs-conceptual/learn/shell/creating-profiles.md index 6b886bee9cf..37db091f80f 100644 --- a/reference/docs-conceptual/learn/shell/creating-profiles.md +++ b/reference/docs-conceptual/learn/shell/creating-profiles.md @@ -2,7 +2,7 @@ description: > This article explains how to use your profile to save preferred PowerShell settings and optimize your shell experience. -ms.date: 02/26/2025 +ms.date: 11/21/2025 title: Customizing your shell environment --- # Customizing your shell environment @@ -22,7 +22,7 @@ on your system. > [!NOTE] > To run scripts in Windows, the PowerShell execution policy needs to be set to `RemoteSigned` at a > minimum. Execution policies don't apply to macOS and Linux. For more information, see -> [about_Execution_Policy][1]. +> [about_Execution_Policy][03]. ## The $PROFILE variable @@ -73,7 +73,7 @@ Console Host on Windows or the default terminal application on other platforms i `Microsoft.PowerShell_profile.ps1`. For Visual Studio Code (VS Code), the filename is `Microsoft.VSCode_profile.ps1`. -For more information, see [about_Profiles][2]. +For more information, see [about_Profiles][05]. ## How to create your personal profile @@ -93,14 +93,14 @@ environment. ## Adding customizations to your profile -The previous articles talked about using [tab completion][3], [command predictors][4], and -[aliases][5]. These articles showed the commands used to load the required modules, create custom -completers, define key bindings, and other settings. These are the kinds of customizations that you -want to have available in every PowerShell interactive session. The profile script is the place for -these settings. +The previous articles talked about using [tab completion][09], [command predictors][11], and +[aliases][10]. These articles showed the commands used to load the required modules, create custom +completers, define key bindings, and other settings. These customizations are the kind that you want +to have available in every PowerShell interactive session. The profile script is the place for these +settings. The simplest way to edit your profile script is to open the file in your favorite code editor. For -example, the following command opens the profile in [VS Code][6]. +example, the following command opens the profile in [VS Code][08]. ```powershell code $PROFILE @@ -177,24 +177,23 @@ Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock $scriptblock This profile script provides examples for the following customization: -- Adds two new [PSDrives][7] for the other root registry hives. -- Creates a [customized prompt][8] that changes if you're running in an elevated session. -- Configures **PSReadLine** and adds key binding. The color settings use the [$PSStyle][9] feature +- Adds two new [PSDrives][04] for the other root registry hives. +- Creates a [customized prompt][06] that changes if you're running in an elevated session. +- Configures **PSReadLine** and adds key binding. The color settings use the [$PSStyle][02] feature to define the ANSI color settings. -- Adds tab completion for the [dotnet CLI][10] tool. The tool provides parameters to help resolve - the command-line arguments. The script block for [Register-ArgumentCompleter][11] uses that +- Adds tab completion for the [dotnet CLI][01] tool. The tool provides parameters to help resolve + the command-line arguments. The script block for [Register-ArgumentCompleter][07] uses that feature to provide the tab completion. - -[1]: /powershell/module/microsoft.powershell.core/about/about_execution_policies -[2]: /powershell/module/microsoft.powershell.core/about/about_profiles -[3]: tab-completion.md -[4]: using-predictors.md -[5]: using-aliases.md -[6]: https://code.visualstudio.com/ -[7]: /powershell/module/microsoft.powershell.core/about/about_filesystem_provider -[8]: /powershell/module/microsoft.powershell.core/about/about_prompts -[9]: /powershell/module/microsoft.powershell.core/about/about_ansi_terminals -[10]: /dotnet/core/tools/ -[11]: /powershell/module/microsoft.powershell.core/register-argumentcompleter +[01]: /dotnet/core/tools/ +[02]: /powershell/module/microsoft.powershell.core/about/about_ansi_terminals +[03]: /powershell/module/microsoft.powershell.core/about/about_execution_policies +[04]: /powershell/module/microsoft.powershell.core/about/about_filesystem_provider +[05]: /powershell/module/microsoft.powershell.core/about/about_profiles +[06]: /powershell/module/microsoft.powershell.core/about/about_prompts +[07]: /powershell/module/microsoft.powershell.core/register-argumentcompleter +[08]: https://code.visualstudio.com/ +[09]: tab-completion.md +[10]: using-aliases.md +[11]: using-predictors.md diff --git a/reference/docs-conceptual/learn/shell/dynamic-help.md b/reference/docs-conceptual/learn/shell/dynamic-help.md index 8e29e2d0bc6..242b434a711 100644 --- a/reference/docs-conceptual/learn/shell/dynamic-help.md +++ b/reference/docs-conceptual/learn/shell/dynamic-help.md @@ -1,7 +1,7 @@ --- description: This article explains how to use the dynamic help feature of PSReadLine. title: Using dynamic help -ms.date: 03/24/2023 +ms.date: 11/21/2025 --- # Using dynamic help @@ -32,11 +32,12 @@ the fully expanded parameter name when you press the Alt+h ![Focused help for a parameter using Alt-h][02] -## Selecting arguments on the command line +## Select arguments on the command line -To quickly select and edit the arguments of a cmdlet without disturbing your syntax using -Alt+a. Based on the cursor position, it searches from the current cursor -position and stops when it finds any arguments on the command line. +To quickly select and edit the arguments of a cmdlet without disturbing your syntax, use +Alt+a. It searches from the current cursor position and stops when it finds +an argument on the command line. It selects the full argument, making it simple to replace or edit +the argument. ![Argument selection using Alt-A][03] diff --git a/reference/docs-conceptual/learn/shell/optimize-shell.md b/reference/docs-conceptual/learn/shell/optimize-shell.md index e874baf6fdd..c7fa227df5d 100644 --- a/reference/docs-conceptual/learn/shell/optimize-shell.md +++ b/reference/docs-conceptual/learn/shell/optimize-shell.md @@ -3,7 +3,7 @@ description: > This article provides an overview of the shell features that help users improve their user experience. title: Optimizing your shell experience -ms.date: 7/14/2022 +ms.date: 11/21/2025 --- # Optimizing your shell experience diff --git a/reference/docs-conceptual/learn/shell/output-for-screen-reader.md b/reference/docs-conceptual/learn/shell/output-for-screen-reader.md index dd33d159a82..a0a9cef1811 100644 --- a/reference/docs-conceptual/learn/shell/output-for-screen-reader.md +++ b/reference/docs-conceptual/learn/shell/output-for-screen-reader.md @@ -1,7 +1,7 @@ --- description: This article aims to guide you through methods to output from PowerShell in formats that are friendly for screen readers, enhancing the accessibility of your scripts. ms.custom: experience -ms.date: 09/12/2024 +ms.date: 11/21/2025 title: Improve the accessibility of output in PowerShell --- # Improve the accessibility of output in PowerShell diff --git a/reference/docs-conceptual/learn/shell/running-commands.md b/reference/docs-conceptual/learn/shell/running-commands.md index 41a911ad2cc..134165ef3b0 100644 --- a/reference/docs-conceptual/learn/shell/running-commands.md +++ b/reference/docs-conceptual/learn/shell/running-commands.md @@ -2,13 +2,13 @@ description: > This article shows how to run commands in PowerShell. title: Running commands in the shell -ms.date: 01/23/2025 +ms.date: 11/21/2025 --- # Running commands in the shell PowerShell is a command-line shell and a scripting language used for automation. Similar to other -shells, like `bash` on Linux or the Windows Command Shell (`cmd.exe`), PowerShell lets you to run -any command available on your system, not just PowerShell commands. +shells, like `bash` on Linux or the Windows Command Shell (`cmd.exe`), PowerShell lets you run any +command available on your system, not just PowerShell commands. ## Types of commands @@ -20,18 +20,18 @@ For any shell in any operating system there are three types of commands: - Examples of `cmd.exe` keywords include: `dir`, `copy`, `move`, `if`, and `echo`. - Examples of PowerShell keywords include: `for`, `foreach`, `try`, `catch`, and `trap`. - Shell language keywords can only be used within the runtime environment of the shell. There is no + Shell language keywords can only be used within the runtime environment of the shell. There's no executable file, external to the shell, that provides the keyword's functionality. - **OS-native commands** are executable files installed in the operating system. The executables can - be run from any command-line shell, like PowerShell. This includes script files that may require - other shells to work properly. For example, if you run a Windows batch script (`.cmd` file) in + be run from any command-line shell, like PowerShell. This includes script files that require other + shells to work properly. For example, if you run a Windows batch script (`.cmd` file) in PowerShell, PowerShell runs `cmd.exe` and passes in the batch file for execution. - **Shell environment-specific commands** are commands defined in external files that can only be - used within the runtime environment of the shell. These include scripts and functions, or they can - be specially compiled modules that add commands to the shell runtime. In PowerShell, these - commands are known as _cmdlets_ (pronounced "command-lets"). + used within the runtime environment of the shell. This include scripts, functions, and modules + that add commands to the shell runtime. In PowerShell, these commands added by a module are known + as _cmdlets_ (pronounced "command-lets"). ## Running native commands @@ -61,11 +61,11 @@ sdwheeler:x:1000:1000:,,,:/home/sdwheeler:/bin/bash Most shells include features for using variables, evaluating expressions, and handling strings. But each shell does these things differently. In PowerShell, all parameters start with a hyphen (`-`) -character. In `cmd.exe`, most parameters use a slash (`/`) character. Other command-line tools may -not have a special character for parameters. +character. In `cmd.exe`, most command parameters use a forward slash (`/`) character. Other +command-line tools might use spaces, hyphens, double-dash (`--`). Each shell has its own way of handling and evaluating strings on the command line. When running -native commands in PowerShell that expect strings to be quoted in a specific way, you may need +native commands in PowerShell that expect strings to be quoted in a specific way, you might need to adjust how you pass those strings. For more information, see the following articles: @@ -86,11 +86,11 @@ In general, the output sent to **stdout** by a native command is sent to the **S PowerShell. Output sent to **stderr** by a native command is sent to the **Error** stream in PowerShell. -When a native command has a non-zero exit code, `$?` is set to `$false`. If the exit code is zero, +When a native command has a nonzero exit code, `$?` is set to `$false`. If the exit code is zero, `$?` is set to `$true`. -However, this changed in PowerShell 7.2. Error records redirected from native commands, like when -using redirection operators (`2>&1`), aren't written to PowerShell's `$Error` variable and the +However, PowerShell 7.2 changed this behavior. Error records redirected from native commands, like +when using redirection operators (`2>&1`), aren't written to PowerShell's `$Error` variable and the preference variable `$ErrorActionPreference` doesn't affect the redirected output. Many native commands write to **stderr** as an alternative stream for additional information. This @@ -110,9 +110,9 @@ the PowerShell scripting language itself. ### PowerShell commands that run other commands The PowerShell **call operator** (`&`) lets you run commands that are stored in variables and -represented by strings or script blocks. You can use this to run any native command or PowerShell -command. This is useful in a script when you need to dynamically construct the command-line -parameters for a native command. For more information, see the [call operator][7]. +represented by strings or script blocks. You can use the operator to run any native command or +PowerShell command. This is useful in a script when you need to dynamically construct the +command-line parameters for a native command. For more information, see the [call operator][7]. The `Start-Process` cmdlet can be used to run native commands, but should only be used when you need to control how the command is executed. The cmdlet has parameters to support the following @@ -140,8 +140,8 @@ For more information, see [Start-Process][8]. On Windows, the `Invoke-Item` cmdlet performs the default action for the specified item. For example, it runs an executable file or opens a document file using the application associated with -the document file type. The default action depends on the type of item and is resolved by the -PowerShell provider that provides access to the item. +the document file type. The default action depends on the type of item and the PowerShell provider +that provides access to the item. The following example opens the PowerShell source code repository in your default web browser. diff --git a/reference/docs-conceptual/learn/shell/tab-completion.md b/reference/docs-conceptual/learn/shell/tab-completion.md index 8c20a45c7b5..74e984df0eb 100644 --- a/reference/docs-conceptual/learn/shell/tab-completion.md +++ b/reference/docs-conceptual/learn/shell/tab-completion.md @@ -4,25 +4,25 @@ description: > extend its capabilities. no-loc: [Tab, Ctrl, Space] title: Using tab-completion in the shell -ms.date: 7/14/2022 +ms.date: 11/21/2025 --- # Using tab-completion in the shell PowerShell provides completions on input to provide hints, enable discovery, and speed up input -entry. Command names, parameter names, argument values and file paths can all be completed by +entry. Command names, parameter names, argument values, and file paths can all be completed by pressing the Tab key. The Tab key is the default key binding on Windows. **PSReadLine** also provides a -`MenuComplete` function that's bound to Ctrl+Space. The `MenuComplete` -function displays a list of matching completions below the command line. +`MenuComplete` function bound to Ctrl+Space. The `MenuComplete` function +displays a list of matching completions below the command line. -These keybindings can be changed using **PSReadLine** cmdlets or the application that's hosting +The keybindings can be changed using **PSReadLine** cmdlets or the application that's hosting PowerShell. Keybindings can be different on non-Windows platforms. For more information, see -[about_PSReadLine_Functions][PSRFunctions]. +[about_PSReadLine_Functions][05]. ## Built-in tab completion features -PowerShell has enabled tab completion for many aspects of the command line experience. +PowerShell enables tab completion for many aspects of the command line experience. ### Filename completion @@ -36,14 +36,14 @@ press. The tab expansion of cmdlet names is slightly different. To use tab expansion on a cmdlet name, type the entire first part of the name (the verb) and the hyphen that follows it. You can fill in more of the name for a partial match. For example, if you type `get-co` and then press the Tab -key, PowerShell automatically expands this to the `Get-Command` cmdlet (notice that it also changes -the case of letters to their standard form). If you press Tab key again, PowerShell -replaces this with the only other matching cmdlet name, `Get-Content`. Tab completion also works to +key, PowerShell automatically expands what you typed to the `Get-Command` cmdlet (notice that it +also changes the case of letters to their standard form). If you press Tab key again, +PowerShell replaces it with the next matching cmdlet, `Get-Content`. Tab completion also works to resolve PowerShell aliases and native executables. The following graphic shows examples of tab and menu completion. -![Tab and menu completion examples](media/tab-completion/tab-menu-complete.gif) +![Tab and menu completion examples][07] ### Other tab completion enhancements @@ -58,7 +58,7 @@ PowerShell 7.0 PowerShell 7.2 -- Fix tab completion for unlocalized `about*` topics +- Fix tab completion for unlocalized `about*` articles - Fix splatting being treated as positional parameter in completions - Add completions for Comment-based Help keywords - Add completion for `#Requires` statements @@ -81,27 +81,26 @@ PowerShell 7.3 - Add type inference support for generic methods with type parameters - Improve type inference and completions - Allows methods to be shown in completion results for `ForEach-Object -MemberName` - - Prevents completion on expressions that return **void** like (`[void]("")`) - - Allows non-default Class constructors to show up when class completion is based on the AST + - Prevents completion on expressions that return **void** like (`[void]""`) + - Allows nondefault Class constructors to show up when class completion is based on the AST ## Other ways to enhance tab completion of command parameters Built-in tab expansion is controlled by the internal function **TabExpansion** or **TabExpansion2**. It's possible to create functions or modules that replace the default behavior of these functions. -You can find examples in the PowerShell Gallery by searching for the [TabExpansion][TabExpansion] -keyword. +You can find examples in the PowerShell Gallery by searching for the [TabExpansion][06] keyword. ### Using the `ValidateSet` or `ArgumentCompletions` attributes with parameters The `ArgumentCompletions` attribute allows you to add tab completion values to a specific parameter. -The `ArgumentCompletions` attribute is similar to `ValidateSet`. Both attributes takes a list of +The `ArgumentCompletions` attribute is similar to `ValidateSet`. Both attributes take a list of values to be presented when the user presses Tab after the parameter name. However, unlike `ValidateSet`, the values aren't validated. For more information, see: -- [ArgumentCompletions][ArgumentCompletions] -- [ValidateSet][ValidateSet] +- [ArgumentCompletions][02] +- [ValidateSet][03] ### Using the `ArgumentCompleter` attribute or `Register-ArgumentCompleter` with parameters @@ -111,14 +110,12 @@ parameter values. The `ArgumentCompleter` attribute allows you to register a function that provides tab completion values to for the parameter. The argument completer function must be available to the function containing the parameter with the `ArgumentCompleter` attribute. Usually, the function is defined in -the same script or module. - -For more information, see [ArgumentCompleter][ArgumentCompleter]. +the same script or module. For more information, see [ArgumentCompleter][04]. The `Register-ArgumentCompleter` cmdlet registers a script block as an argument completer function -at run time for any command you specify. This allows you to define argument completers outside of -the script or module or for native commands. For more information, see -[Register-ArgumentCompleter][Register-ArgumentCompleter]. +at run time for any command you specify. Using `Register-ArgumentCompleter` allows you to define +argument completers outside of the script or module or for native commands. For more information, +see [Register-ArgumentCompleter][09]. ## Predictive IntelliSense in PSReadLine @@ -130,12 +127,14 @@ that use advanced logic to provide suggestions for full commands. The **Az.Tools was the first plug-in for Predictive IntelliSense. It uses Machine Learning to predict what Azure PowerShell command you want to run and the parameters you want to use. -For more information, see [Using predictors](using-predictors.md). +For more information, see [Using predictors][08]. -[ArgumentCompleter]: /powershell/module/microsoft.powershell.core/about/about_functions_argument_completion#argumentcompleter-attribute -[ArgumentCompletions]: /powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters#argumentcompletions-attribute -[PSRFunctions]: /powershell/module/psreadline/about/about_psreadline_functions#completion-functions -[Register-ArgumentCompleter]: xref:Microsoft.PowerShell.Core.Register-ArgumentCompleter -[TabExpansion]: https://www.powershellgallery.com/packages?q=tabexpansion -[ValidateSet]: /powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters#validateset-attribute +[02]: /powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters#argumentcompletions-attribute +[03]: /powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters#validateset-attribute +[04]: /powershell/module/microsoft.powershell.core/about/about_functions_argument_completion#argumentcompleter-attribute +[05]: /powershell/module/psreadline/about/about_psreadline_functions#completion-functions +[06]: https://www.powershellgallery.com/packages?q=tabexpansion +[07]: media/tab-completion/tab-menu-complete.gif +[08]: using-predictors.md +[09]: xref:Microsoft.PowerShell.Core.Register-ArgumentCompleter diff --git a/reference/docs-conceptual/learn/shell/using-aliases.md b/reference/docs-conceptual/learn/shell/using-aliases.md index 9150a265225..d2b3d296396 100644 --- a/reference/docs-conceptual/learn/shell/using-aliases.md +++ b/reference/docs-conceptual/learn/shell/using-aliases.md @@ -1,6 +1,6 @@ --- -description: This article describe how to use aliases in PowerShell. -ms.date: 07/23/2024 +description: This article describes how to use aliases in PowerShell. +ms.date: 11/21/2025 title: Using aliases --- # Using aliases @@ -69,7 +69,7 @@ Set-Alias -Name cmpo -Value Compare-Object ## Compatibility aliases in Windows PowerShell has several aliases that allow **Unix** and `cmd.exe` users to use familiar commands in -Windows. The following table show common commands, the related PowerShell cmdlet, and the PowerShell +Windows. The following table shows common commands, the related PowerShell cmdlet, and the PowerShell alias: | Windows Command Shell | Unix command | PowerShell cmdlet | PowerShell alias | @@ -83,22 +83,22 @@ alias: | `md` | `mkdir` | `New-Item` | `ni` | | `move` | `mv` | `Move-Item` | `mi`, `move`, `mv` | | `popd` | `popd` | `Pop-Location` | `popd` | -| | `pwd` | `Get-Location` | `gl`, `pwd` | +| | `pwd` | `Get-Location` | `gl`, `pwd`, `$PWD` | | `pushd` | `pushd` | `Push-Location` | `pushd` | | `ren` | `mv` | `Rename-Item` | `rni`, `ren` | | `type` | `cat` | `Get-Content` | `gc`, `cat`, `type` | > [!NOTE] -> The aliases in this table are Windows-specific. Some aliases aren't available on other platforms. -> This is to allow the native command to work in a PowerShell session. For example, `ls` isn't -> defined as a PowerShell alias on macOS or Linux so that the native command is run instead of -> `Get-ChildItem`. +> The aliases in this table are Windows-specific. Some aliases aren't available on other platforms +> to allow an existing native command to work in a PowerShell session. For example, `ls` isn't +> defined as a PowerShell alias on macOS or Linux so that PowerShell runs the native command instead +> of `Get-ChildItem`. ## Creating alternate names for commands with parameters You can assign an alias to a cmdlet, script, function, or executable file. Unlike some Unix shells, -you cannot assign an alias to a command with parameters. For example, you can assign an alias to the -`Get-Eventlog` cmdlet, but you cannot assign an alias to the `Get-Eventlog -LogName System` command. +the definition of the alias can't include parameters. For example, you can assign an alias to the +`Get-Eventlog` cmdlet, but you can't assign an alias to the `Get-Eventlog -LogName System` command. You must create a function that contains the command with parameters. For more information, see [about_Aliases][02]. @@ -106,14 +106,14 @@ For more information, see [about_Aliases][02]. ## Parameter aliases and shorthand names PowerShell also provides ways to create shorthand names for parameters. Parameter aliases are -defined using the `Alias` attribute when you declare the parameter. These can't be defined using the -`*-Alias` cmdlets. +defined using the `Alias` attribute when you declare the parameter. Parameter aliases can't be +defined using the `*-Alias` cmdlets. For more information, see the [Alias attribute][03] documentation. In addition to parameter aliases, PowerShell lets you specify the parameter name using the fewest characters needed to uniquely identify the parameter. For example, the `Get-ChildItem` cmdlet has -the **Recurse** and **ReadOnly** parameters. To uniquely identify the **Recurse** parameter you only +the **Recurse** and **ReadOnly** parameters. To uniquely identify the Recurse parameter, you only need to provide `-Rec`. If you combine that with the command alias, `Get-ChildItem -Recurse` can be shortened to `dir -Rec`. @@ -122,8 +122,8 @@ shortened to `dir -Rec`. Aliases are a convenience feature to be used interactively in the shell. You should always use the full command and parameter names in your scripts. -- Aliases can be deleted or redefined in a profile script -- Any aliases you define may not be available to the user of your scripts +- You can delete or redefine aliases in a profile script +- Aliases you define in your profile aren't be available to other users - Aliases make your code harder to read and maintain diff --git a/reference/docs-conceptual/learn/shell/using-keyhandlers.md b/reference/docs-conceptual/learn/shell/using-keyhandlers.md index 14e73a3c958..fcc45084184 100644 --- a/reference/docs-conceptual/learn/shell/using-keyhandlers.md +++ b/reference/docs-conceptual/learn/shell/using-keyhandlers.md @@ -1,7 +1,7 @@ --- description: This article explains how to use PSReadLine keybindings for various platforms and terminals applications. title: Using PSReadLine key handlers -ms.date: 03/27/2023 +ms.date: 11/21/2025 --- # Using PSReadLine key handlers @@ -20,7 +20,8 @@ defined. Get-PSReadLineKeyHandler ``` -You can also get a list of all unbound **PSReadLine** functions that are available to be bound to a key chord. +You can also get a list of all unbound **PSReadLine** functions that are available to be bound to a +key chord. ```powershell Get-PSReadLineKeyHandler -Unbound @@ -35,11 +36,11 @@ Set-PSReadLineKeyHandler -Chord 'Ctrl+Spacebar' -Function MenuComplete ## Finding key names and chord bindings -The names of the keys in the chord are defined by the `[System.ConsoleKey]` enumeration. For more -information, see [System.ConsoleKey][05] documentation. For example, the name of the 2 -key in `[System.ConsoleKey]` is `D2`, whereas the name of the 2 key on the numeric keypad -is `NumPad2`. You can use the `[System.Console]::ReadKey()` method to find the name of the key you -pressed. +The names of the keys in the chord match the names in the `[System.ConsoleKey]` enumeration. For +more information, see [System.ConsoleKey][05] documentation. For example, the name of the +2 key in `[System.ConsoleKey]` is `D2`, whereas the name of the 2 key on the +numeric keypad is `NumPad2`. You can use the `[System.Console]::ReadKey()` method to find the name +of the key you pressed. ```powershell [System.Console]::ReadKey() @@ -80,14 +81,14 @@ Ctrl+h BackwardDeleteChar Delete the character before the cursor > Ctrl+X and Ctrl+x. On Windows, you can also use the Alt+? key chord to show the function bound to -the next key chord you enter. When you type Alt+? you see the following +the next key chord you enter. When you type Alt+?, you see the following prompt: ```Output what-is-key: ``` -When you hit the Backspace key you get the following response: +When you hit the Backspace key, you get the following response: ```Output Backspace: BackwardDeleteChar - Delete the character before the cursor @@ -96,7 +97,7 @@ Backspace: BackwardDeleteChar - Delete the character before the cursor ## Key handlers on non-Windows computers The key codes generated by your keyboard can be different depending on the operating system and -terminal application you are using. +terminal application you're using. ### macOS @@ -124,7 +125,7 @@ allows the ⌥ Option key to act as Alt in the iTerm ![Screenshot of iTerm.app settings.][01] > [!NOTE] -> The exact steps may vary depending on the versions of macOS and the terminal applications. These +> The exact steps vary depending on the versions of macOS and the terminal applications. These > examples were captured on macOS Ventura 13.2.1 and iTerm2 v3.4.16. ### Linux @@ -133,7 +134,8 @@ On Linux platforms, the key code generated can be different than other systems. - Ctrl+[ is the same as Escape - Ctrl+Spacebar generates the key codes for Ctrl+D2. If - you want to map a function Ctrl+Spacebar you must use the chord `Ctrl+D2`. + you want to map a function to Ctrl+Spacebar, you must use the chord + `Ctrl+D2`. ```powershell Set-PSReadLineKeyHandler -Chord 'Ctrl+D2' -Function MenuComplete @@ -143,8 +145,8 @@ Use the `ReadKey()` method to verify the key codes generated by your keyboard. ## Commonly used key handlers -Here are a few commonly used key handlers that are bound by default on Windows. Note that the key -binding may be different on non-Windows platforms. +Here are a few commonly used key handlers that are bound by default on Windows. Keybindings can be +different on non-Windows platforms. ### MenuComplete @@ -179,8 +181,8 @@ Selects the next argument on the command line. Default chord: `Alt+a` -You may have command in your history that you want to run again with different parameter values. You -can use the chord to cycle through each parameter and change the value as needed. +You might have command in your history that you want to run again with different parameter values. +You can use the chord to cycle through each parameter and change the value as needed. `New-AzVM -ResourceGroupName myRGName -Location eastus -Name myVM` @@ -193,13 +195,14 @@ Moves the cursor to the matching brace. Default chord: `Ctrl+]` -This functions moves your cursor to the closing brace that matches the brace at the current cursor -position on the command line. The function works for brackets (`[]`), braces (`{}`), and -parentheses, (`()`). +The `GotoBrace` function moves your cursor to the closing brace that matches the brace at the +current cursor position on the command line. The function works for brackets (`[]`), braces (`{}`), +and parentheses (`()`). ### DigitArgument -Start or accumulate a numeric argument use to repeat a keystroke the specified number of times. +Start or accumulate a numeric argument that's used to repeat a keystroke the specified number of +times. Default chord: `Alt+0` through `Alt+9` diff --git a/reference/docs-conceptual/learn/shell/using-light-theme.md b/reference/docs-conceptual/learn/shell/using-light-theme.md index 3e4879f4d7d..7ead6f46f96 100644 --- a/reference/docs-conceptual/learn/shell/using-light-theme.md +++ b/reference/docs-conceptual/learn/shell/using-light-theme.md @@ -1,14 +1,14 @@ --- description: > This article shows how to configure PSReadLine color settings for a light themed terminal. -ms.date: 12/17/2022 +ms.date: 11/21/2025 title: Configuring a light colored theme --- # Configuring a light colored theme The default colors for both PowerShell and **PSReadLine** are selected for a dark background -terminal. However, some users may choose to use a light background with dark text. Since most of the -default colors don't set the background, using light foreground colors on a light background +terminal. However, some users might choose to use a light background with dark text. Since most of +the default colors don't set the background, using light foreground colors on a light background produces unreadable text. **PSReadLine** allows you to define colors for 18 different syntax elements. You can view the @@ -141,8 +141,8 @@ $PSStyle.FileInfo.Extension['.psm1'] = "`e[36m" ## Choosing colors for accessibility -The ISE color theme may not work for users with color-blindness or other conditions that limit their -ability to see colors. +The ISE color theme might not work for users with color-blindness or other conditions that limit +their ability to see colors. The [World Wide Web Consortium (W3C)][05] has recommendations for using colors for accessibility. The Web Content Accessibility Guidelines (WCAG) 2.1 recommends that "visual presentation of text and diff --git a/reference/docs-conceptual/learn/shell/using-predictors.md b/reference/docs-conceptual/learn/shell/using-predictors.md index 7f69e2ba1fa..c38de4d9d7c 100644 --- a/reference/docs-conceptual/learn/shell/using-predictors.md +++ b/reference/docs-conceptual/learn/shell/using-predictors.md @@ -1,7 +1,7 @@ --- description: This article describes the features and usage of Predictive IntelliSense in PSReadLine. title: Using predictors in PSReadLine -ms.date: 7/14/2022 +ms.date: 11/21/2025 --- # Using predictors in PSReadLine @@ -16,11 +16,11 @@ modules that use advanced logic to provide suggestions for full commands. The la When Predictive IntelliSense is enabled, the prediction suggestion appears as colored text following the user's cursor. The suggestions from Predictive IntelliSense help new and experienced users of PowerShell discover, edit, and execute full commands based on matching predictions. Suggestions can -come from the user's history and additional domain specific plugins. +come from the user's history and other domain-specific plugins. ![Inline view of a prediction][07] -The previous images shows the default `InlineView` of the suggestion. Pressing RightArrow +The previous image shows the default `InlineView` of the suggestion. Pressing RightArrow key accepts an inline suggestion. After accepting the suggestion, you can edit the command line before hitting Enter to run the command. @@ -37,7 +37,7 @@ pressing the F2 key. You can also use the **PredictionViewStyle** par ## Managing Predictive IntelliSense -To use Predictive IntelliSense you must have a newer version of **PSReadLine** installed. For best +To use Predictive IntelliSense, you must have a newer version of **PSReadLine** installed. For best results, install the latest version of the module. Install **PSReadLine** using the [Microsoft.PowerShell.PSResourceGet][05] module: @@ -46,8 +46,7 @@ Install **PSReadLine** using the [Microsoft.PowerShell.PSResourceGet][05] module Install-PSResource -Name PSReadLine ``` -**PSReadLine** can be installed in Windows PowerShell 5.1 or in PowerShell 7 or higher. To use -predictor plug-ins you must be running in PowerShell 7.2 or higher. Windows PowerShell 5.1 can use +**PSReadLine** can be installed in Windows PowerShell 5.1 or in PowerShell 7 or higher. To use predictor plug-ins, you must be running in PowerShell 7.2 or higher. Windows PowerShell 5.1 can use the history-based predictor. In **PSReadLine** 2.2.6, Predictive IntelliSense is enabled by default depending on the following @@ -117,9 +116,9 @@ Set-PSReadLineKeyHandler -Chord "Ctrl+f" -Function ForwardWord With this binding, pressing Ctrl+f accepts the next word of an inline suggestion when the cursor is at the end of current editing line. You can bind other keys to -`AcceptSuggestion` and `AcceptNextSuggestionWord` for similar functionalities. For example, you may -want to make RightArrow accept the next word of the inline suggestion, instead of the -whole suggestion line. +`AcceptSuggestion` and `AcceptNextSuggestionWord` for similar functionalities. For example, you +might want to make RightArrow accept the next word of the inline suggestion, instead of +the whole suggestion line. ```powershell Set-PSReadLineKeyHandler -Chord "RightArrow" -Function ForwardWord @@ -140,7 +139,7 @@ install the [CompletionPredictor][04] module from the PowerShell Gallery. ![PowerShell IntelliSense using the CompletionPredictor][06] As previously noted, `ListView` shows you the source of the prediction. If you have multiple -plug-ins installed the predictions are grouped by source with **History** listed first followed by +plug-ins installed, the predictions are grouped by source with **History** listed first followed by each plug-in in the order that they were loaded. ## Creating your own predictor module diff --git a/reference/docs-conceptual/security/overview.yml b/reference/docs-conceptual/security/overview.yml index 3ddaf302033..eb84e9329d5 100644 --- a/reference/docs-conceptual/security/overview.yml +++ b/reference/docs-conceptual/security/overview.yml @@ -6,7 +6,7 @@ metadata: title: PowerShell Security description: Learn about PowerShell's security features and best practices. ms.topic: landing-page - ms.date: 03/28/2024 + ms.date: 11/21/2025 # linkListType: architecture | concept | deploy | download | get-started | # how-to-guide | tutorial | overview | quickstart | reference | diff --git a/reference/docs-conceptual/what-is-windows-powershell.md b/reference/docs-conceptual/what-is-windows-powershell.md index 5f896d5fbda..e6291ef4e1a 100644 --- a/reference/docs-conceptual/what-is-windows-powershell.md +++ b/reference/docs-conceptual/what-is-windows-powershell.md @@ -1,6 +1,6 @@ --- description: This article explains the difference between Windows PowerShell and PowerShell. -ms.date: 03/07/2024 +ms.date: 11/20/2025 ms.topic: overview title: What is Windows PowerShell? --- diff --git a/reference/module/index.md b/reference/module/index.md index be1a936e67d..3a6d7bd0680 100644 --- a/reference/module/index.md +++ b/reference/module/index.md @@ -6,7 +6,7 @@ description: Search all PowerShell modules and cmdlets from Microsoft layout: ApiBrowserPage manager: sewhee ms.author: sewhee -ms.date: 01/18/2024 +ms.date: 11/20/2025 ms.devlang: powershell ms.manager: sewhee ms.product: powershell