d98f131c5a
# PR Summary <!-- Summarize your PR between here and the checklist. --> ## PR Context follow-up #12190 ## PR Checklist - [x] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - Use the present tense and imperative mood when describing your changes - [x] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] [Make sure all `.h`, `.cpp`, `.cs`, `.ps1` and `.psm1` files have the correct copyright header](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [x] This PR is ready to merge and is not [Work in Progress](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---work-in-progress). - If the PR is work in progress, please add the prefix `WIP:` or `[ WIP ]` to the beginning of the title (the `WIP` bot will keep its status check at `Pending` while the prefix is present) and remove the prefix when the PR is ready. - **[Breaking changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)** - [x] None - **OR** - [ ] [Experimental feature(s) needed](https://github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/reference/6/Microsoft.PowerShell.Core/About/about_Experimental_Features.md) - [ ] Experimental feature name(s): <!-- Experimental feature name(s) here --> - **User-facing changes** - [x] Not Applicable - **OR** - [ ] [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed: <!-- Number/link of that issue here --> - **Testing - New and feature** - [x] N/A or can only be tested interactively - **OR** - [ ] [Make sure you've added a new test if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) - **Tooling** - [x] I have considered the user experience from a tooling perspective and don't believe tooling will be impacted. - **OR** - [ ] I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include: - Impact on [PowerShell Editor Services](https://github.com/PowerShell/PowerShellEditorServices) which is used in the [PowerShell extension](https://github.com/PowerShell/vscode-powershell) for VSCode (which runs in a different PS Host). - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features. - Impact on [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) (which provides linting & formatting in the editor extensions). - Impact on [EditorSyntax](https://github.com/PowerShell/EditorSyntax) (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
123 lines
4.2 KiB
Markdown
123 lines
4.2 KiB
Markdown
pwsh(1) -- PowerShell command-line shell and .NET REPL
|
|
=================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`pwsh` [`-NoLogo`] [`-NoExit`] [`-NoProfile`] [`-NonInteractive`]
|
|
[`-InputFormat` {Text | XML}] [`-OutputFormat` {Text | XML}]
|
|
[`-EncodedCommand` <Base64EncodedCommand>]
|
|
[`-File` <filePath> <args>] [`-ExecutionPolicy` <ExecutionPolicy>]
|
|
[`-Command` { `-` | <script-block> [`-args` <arg-array>] | <string> [<CommandParameters>] } ]
|
|
|
|
## DESCRIPTION
|
|
|
|
PowerShell is an automation and configuration management platform.
|
|
It consists of a cross-platform (Windows, Linux and macOS)
|
|
command-line shell and associated scripting language.
|
|
|
|
## OPTIONS
|
|
|
|
PowerShell accepts both `-` and `--` prefixed arguments.
|
|
|
|
* `-NoLogo`:
|
|
Hides the copyright banner at startup.
|
|
|
|
* `-NoExit`:
|
|
Does not exit after running startup commands.
|
|
|
|
* `-NoProfile`:
|
|
Does not load the PowerShell profile.
|
|
|
|
* `-NonInteractive`:
|
|
Does not present an interactive prompt to the user.
|
|
|
|
* `-InputFormat`:
|
|
Describes the format of data sent to PowerShell.
|
|
Valid values are "Text" (text strings) or "XML" (serialized CLIXML format).
|
|
|
|
* `-OutputFormat`:
|
|
Determines how output from PowerShell is formatted.
|
|
Valid values are "Text" (text strings) or "XML" (serialized CLIXML format).
|
|
|
|
* `-EncodedCommand`:
|
|
Accepts a base-64-encoded string version of a command.
|
|
Use this parameter to submit commands to PowerShell that
|
|
require complex quotation marks or curly braces.
|
|
|
|
* `-File`:
|
|
Runs the specified script in the local scope ("dot-sourced"),
|
|
so that the functions and variables that the script creates are available in the current session.
|
|
Enter the script file path and any parameters.
|
|
File must be the last parameter in the command,
|
|
because all characters typed after the File parameter name are
|
|
interpreted as the script file path followed by the script parameters.
|
|
|
|
* `-ExecutionPolicy`:
|
|
Sets the default execution policy for the current session and saves it in the
|
|
$env:PSExecutionPolicyPreference environment variable.
|
|
This parameter does not change the PowerShell execution policy that is set in the registry.
|
|
|
|
* `-Command`:
|
|
Executes the specified commands (and any parameters) as though they were typed at the PowerShell command prompt,
|
|
and then exits, unless NoExit is specified.
|
|
The value of Command can be `-`, a string or a script block.
|
|
If the value of Command is `-`, the command text is read from standard input.
|
|
If the value of Command is a script block, the script block must be enclosed in braces (`{}`).
|
|
You can specify a script block only when running PowerShell in PowerShell.
|
|
The results of the script block are returned to the parent shell as deserialized XML objects, not live objects.
|
|
If the value of Command is a string, Command must be the last parameter in the command,
|
|
because any characters typed after the command are interpreted as the command arguments.
|
|
|
|
To write a string that runs a PowerShell command,
|
|
use the format: `& {<command>}` where the quotation marks indicate a string and the
|
|
invoke operator (`&`) causes the command to be executed.
|
|
|
|
* `-Help`, `-?`, `/?`:
|
|
Shows this message.
|
|
|
|
## FILES
|
|
|
|
* `~/.config/powershell/Microsoft.PowerShell_profile.ps1`
|
|
User profile.
|
|
|
|
* `~/.local/share/powershell/Modules`
|
|
User modules.
|
|
|
|
* `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt`
|
|
User PSReadLine history file.
|
|
|
|
## ENVIRONMENT
|
|
|
|
These are environment variables used by PowerShell.
|
|
|
|
* `$PSModulePath`:
|
|
A colon (`:`) separated load path for PowerShell modules.
|
|
|
|
## AUTOMATIC VARIABLES
|
|
|
|
These are automatically defined PowerShell-language variables.
|
|
|
|
* `$PSHOME`:
|
|
This is the location of all the system PowerShell binaries, modules, configuration, etc.
|
|
|
|
* `$PROFILE`:
|
|
Location for user configuration file.
|
|
|
|
* `$HOST`:
|
|
Contains an object that represents the program that is hosting PowerShell (similar to `Get-Host`).
|
|
|
|
* `$LASTEXITCODE`:
|
|
Contains the exit code of the last native process that ran in PowerShell (not cmdlets, as those are in-process).
|
|
|
|
* `$PWD`:
|
|
Contains an object that represents the current working location (similar to `Get-Location`).
|
|
|
|
## SEE ALSO
|
|
|
|
* https://microsoft.com/powershell
|
|
* https://github.com/PowerShell/PowerShell
|
|
|
|
## COPYRIGHT
|
|
|
|
Copyright (c) Microsoft Corporation.
|