使用英语阅读

通过

about_Pwsh

  • 项目

简短说明

说明如何使用 pwsh 命令-line 接口。 显示命令-line 参数并描述语法。

长说明

有关 Windows PowerShell 5.1 的命令-line 选项的信息，请参阅 about_PowerShell_exe。

语法

Usage: pwsh[.exe]
    [-Login]
    [[-File] <filePath> [args]]
    [-Command { - | <script-block> [-args <arg-array>]
                  | <string> [<CommandParameters>] } ]
    [[-CommandWithArgs <string>] [<CommandParameters>]]
    [-ConfigurationFile <filePath>]
    [-ConfigurationName <string>]
    [-CustomPipeName <string>]
    [-EncodedCommand <Base64EncodedCommand>]
    [-ExecutionPolicy <ExecutionPolicy>]
    [-InputFormat {Text | XML}]
    [-Interactive]
    [-MTA]
    [-NoExit]
    [-NoLogo]
    [-NonInteractive]
    [-NoProfile]
    [-NoProfileLoadTime]
    [-OutputFormat {Text | XML}]
    [-SettingsFile <filePath>]
    [-SSHServerMode]
    [-STA]
    [-Version]
    [-WindowStyle <style>]
    [-WorkingDirectory <directoryPath>]

pwsh[.exe] -h | -Help | -? | /?

参数

所有参数都区分大小写，-i不区分大小写。

-File |-f

文件 的值可以是 - 或文件路径和可选参数。 如果 -文件 的值，则从标准输入读取命令。

如果没有参数，但命令行中存在值，则这是默认参数。 指定的脚本在新会话的本地作用域（“dot-sourced”）中运行，以便脚本创建的函数和变量在新会话中可用。 输入脚本文件路径和任何参数。 文件必须是命令中的最后一个参数，因为在 File 参数名称之后键入的所有字符都解释为脚本文件路径，后跟脚本参数。

通常，包括或省略脚本的开关参数。 例如，以下命令使用 Get-Script.ps1 脚本文件的 All 参数：-File .\Get-Script.ps1 -All

在极少数情况下，可能需要为 switch 参数提供 布尔值 值。 若要在 File 参数的值中为 switch 参数提供 布尔 值，请使用参数通常紧跟冒号和布尔值，例如：-File .\Get-Script.ps1 -All:$False。

传递给脚本的参数在由当前 shell 解释后作为文本字符串传递。 例如，如果处于 cmd.exe 并且想要传递环境变量值，则可以使用 cmd.exe 语法：pwsh -File .\test.ps1 -TestParam %windir%

相比之下，在 cmd.exe 中运行 pwsh -File .\test.ps1 -TestParam $env:windir 会导致脚本接收文本字符串 $env:windir，因为它对当前 cmd.exe shell 没有特殊意义。 环境变量引用的 $env:windir 样式 可以在 Command 参数中使用，因为它被解释为 PowerShell 代码。

同样，如果要从 Batch 脚本执行相同的命令，则可以使用 %~dp0 而不是 .\ 或 $PSScriptRoot 来表示当前执行目录：pwsh -File %~dp0test.ps1 -TestParam %windir%。 如果改用 .\test.ps1，PowerShell 会引发错误，因为它找不到文本路径 .\test.ps1

备注

文件 参数不支持使用需要参数值数组的参数的脚本。 遗憾的是，本机命令如何获取参数值是一个限制。 调用本机可执行文件（如 powershell 或 pwsh），它不知道对数组执行的作，因此它作为字符串传递。

如果 -文件 的值，则从标准输入读取命令。 在没有重定向的标准输入的情况下运行 pwsh -File - 将启动常规会话。 这与根本不指定 File 参数相同。 从标准输入读取时，输入语句一次执行一个语句，就像在 PowerShell 命令提示符处键入一样。 如果语句分析不正确，则不会执行该语句。 进程退出代码由输入中最后一个（已执行）命令的状态确定。 正常终止时，退出代码始终 0。 当脚本文件以 exit 命令终止时，进程退出代码将设置为与 exit 命令一起使用的数字参数。

与 -Command类似，当发生脚本终止错误时，退出代码将设置为 1。 但是，与 -Command不同，当执行中断时，Ctrl+C 退出代码 0。 有关详细信息，请参阅 about_Automatic_Variables中的 $LASTEXITCODE。

备注

从 PowerShell 7.2 起，文件 参数仅接受 Windows 上的 .ps1 文件。 如果提供了另一种文件类型，则会引发错误。 此行为特定于 Windows。 在其他平台上，PowerShell 会尝试运行其他文件类型。

-Command |-c

Command 的值可以是 -、脚本块或字符串。 如果 命令 的值 -，则从标准输入读取命令文本。

Command 参数仅接受脚本块以供执行，当它可以将传递给 Command 的值识别为 ScriptBlock 类型。 仅当从另一个 PowerShell 主机运行 pwsh 时，才能 。 ScriptBlock 类型可以包含在现有变量中，从表达式返回，或由 PowerShell 主机分析为文本脚本块，包含在大括号（{}），然后传递给 pwsh。

PowerShell 
pwsh -Command {Get-WinEvent -LogName security}

在 cmd.exe中，没有脚本块（或 ScriptBlock 类型），因此传递给 Command 的值始终 字符串。 可以在字符串中编写脚本块，但与其执行脚本块的行为完全相同，就像在典型的 PowerShell 提示符下键入脚本块一样，而是将脚本块的内容打印回你。

传递给 Command 的字符串仍作为 PowerShell 代码执行，因此从 cmd.exe运行时，通常不需要脚本块大括号。 若要执行字符串中定义的内联脚本块，可以使用 调用运算符&：

PowerShell 
pwsh -Command "& {Get-WinEvent -LogName security}"

如果 Command 的值是字符串，Command 必须是 pwsh 的最后一个参数，因为其后面的所有参数都将解释为要执行的命令的一部分。

从现有 PowerShell 会话中调用时，结果将作为反序列化的 XML 对象（而不是实时对象）返回到父 shell。 对于其他 shell，结果将作为字符串返回。

如果 -命令 的值，则从标准输入读取命令。 在将 Command 参数与标准输入配合使用时，必须重定向标准输入。 例如：

PowerShell 
@'
"in"

"hi" |
  % { "$_ there" }

"out"
'@ | pwsh -NoProfile -Command -

此示例生成以下输出：

Output 
in
hi there
out

从标准输入进行读取时，将分析并一次执行一个语句，就像在 PowerShell 命令提示符处键入它们一样。 如果输入代码无法正确分析，则不会执行该语句。 除非使用 -NoExit 参数，否则当没有从标准输入读取的输入时，PowerShell 会话将退出。

进程退出代码由输入中最后一个（已执行）命令的状态确定。 当 $true$? 或 1$?$false时，退出代码 0。 如果最后一个命令是外部程序或显式设置除 0 或 1以外的退出代码的 PowerShell 脚本，则退出代码将转换为进程退出代码的 1。 同样，当发生脚本终止（runspace-terminating）错误（如 throw 或 -ErrorAction Stop）时，或者当 Ctrl+C中断执行时，将返回值 1。

若要保留特定的退出代码，请将 exit $LASTEXITCODE 添加到命令字符串或脚本块。 有关详细信息，请参阅 about_Automatic_Variables中的 $LASTEXITCODE。

-CommandWithArgs |-cwa

这是 7.4 中添加的实验性功能，成为 PowerShell 7.5-preview.5 中的主流功能。

使用参数执行 PowerShell 命令。 与 -Command不同，此参数将填充命令可以使用的-in 变量生成的 $args。

第一个字符串是命令。 用空格分隔的其他字符串是参数。

例如：

PowerShell 
pwsh -CommandWithArgs '$args | % { "arg: $_" }' arg1 arg2

此示例生成以下输出：

Output 
arg: arg1
arg: arg2

备注

如果从 cmd.exe 或 powershell.exe运行，则 用引号分析参数 会导致示例失败。 若要从这些运行，可以使用

Cmd 
REM Quoting required when run from cmd.exe
pwsh -CommandWithArgs "$args | % { ""arg: $_"" }" arg1 arg2
PowerShell 
# Quoting required when run from powershell.exe
pwsh -CommandWithArgs '"$args | % { ""arg: $_"" }"' arg1 arg2

-ConfigurationName |-config

指定运行 PowerShell 的配置终结点。 这可以是在本地计算机上注册的任何终结点，包括默认 PowerShell 远程处理终结点或具有特定用户角色功能的自定义终结点。

示例：pwsh -ConfigurationName AdminRoles

-ConfigurationFile

指定会话配置（.pssc）文件路径。 配置文件中包含的配置将应用于 PowerShell 会话。

示例：pwsh -ConfigurationFile "C:\ProgramData\PowerShell\MyConfig.pssc"

-CustomPipeName

指定要用于调试和其他跨进程通信的其他 IPC 服务器（命名管道）的名称。 这提供了连接到其他 PowerShell 实例的可预测机制。 通常用于 Enter-PSHostProcess上的 CustomPipeName 参数。

此参数是在 PowerShell 6.2 中引入的。

例如：

PowerShell 
# PowerShell instance 1
pwsh -CustomPipeName mydebugpipe
# PowerShell instance 2
Enter-PSHostProcess -CustomPipeName mydebugpipe

-EncodedCommand |-e |-ec

接受 Base64-e命令的编码字符串版本。 使用此参数将命令提交到需要复杂嵌套引用的 PowerShell。 Base64 表示形式必须是 UTF-16LE 编码的字符串。

例如：

PowerShell 
$command = 'dir "c:\program files" '
$bytes = [System.Text.Encoding]::Unicode.GetBytes($command)
$encodedCommand = [Convert]::ToBase64String($bytes)
pwsh -EncodedCommand $encodedCommand

-ExecutionPolicy |-ex |-ep

设置当前会话的默认执行策略，并将其保存在 $env:PSExecutionPolicyPreference 环境变量中。 此参数不会更改持久配置的执行策略。

此参数仅适用于 Windows 计算机。 在非 Windows 平台上，将忽略提供的参数和值。

-InputFormat |-inp |-if

描述发送到 PowerShell 的数据的格式。 有效值为“Text”（文本字符串）或“XML”（序列化 CLIXML 格式）。

-Interactive |-i

向用户显示交互式提示。 NonInteractive 参数的反函数。

-Login |-l

在 Linux 和 macOS 上，使用 /bin/sh 以登录 shell 的形式启动 PowerShell，以执行 /etc/profile 和 ~/.profile 等登录配置文件。 在 Windows 上，此开关不执行任何作。

重要

此参数必须首先以登录 shell 的形式启动 PowerShell。 如果在另一位置传递此参数，则忽略此参数。

若要在 UNIX-like作系统上将 pwsh 设置为登录 shell，请执行以下作：

  • 验证 pwsh 的完整绝对路径是否列在 /etc/shells

    • 此路径通常类似于 Linux 上的 /usr/bin/pwsh 或在 macOS 上 /usr/local/bin/pwsh
    • 使用某些安装方法时，将在安装时自动添加此项
    • 如果 /etc/shells中不存在 pwsh，请使用编辑器将路径追加到最后一行上的 pwsh。 这需要提升的权限才能编辑。

  • 使用 chsh 实用工具将当前用户的 shell 设置为 pwsh：

    sh 
    chsh -s /usr/bin/pwsh

警告

在适用于 Linux 的 Windows 子系统（WSL）上，由于登录 shell 当前不支持设置 pwsh，并且尝试将 pwsh 设置为登录 shell，可能会导致无法以交互方式启动 WSL。

-MTA

使用多线程单元启动 PowerShell。 此开关仅在 Windows 上可用。 在非 Windows 平台上使用此参数会导致错误。

-NoExit |-noe

运行启动命令后不会退出。

示例：pwsh -NoExit -Command Get-Date

-NoLogo |-nol

在交互式会话启动时隐藏横幅。

-NonInteractive |-noni

此开关用于创建不应要求用户输入的会话。 这对于在计划任务或 CI/CD 管道中运行的脚本非常有用。 任何尝试使用交互式功能（如 Read-Host 或确认提示）都会导致语句终止错误，而不是挂起。

-NoProfile |-nop

不加载 PowerShell 配置文件。

-NoProfileLoadTime

隐藏加载时间超过 500 毫秒时启动时显示的 PowerShell 配置文件加载时间文本。

-OutputFormat |-o |-of

确定 PowerShell 的输出的格式。 有效值为“Text”（文本字符串）或“XML”（序列化 CLIXML 格式）。

示例：pwsh -o XML -c Get-Date

在 PowerShell 会话中调用时，你会获得反序列化的对象作为输出而不是纯字符串。 从其他 shell 调用时，输出是格式化为 CLIXML 文本的字符串数据。

-SettingsFile |-settings

替代会话的系统-wide powershell.config.json 设置文件。 默认情况下，系统-wide 设置从 $PSHOME 目录中的 powershell.config.json 读取。

请注意，-ConfigurationName 参数指定的终结点不使用这些设置。

示例：pwsh -SettingsFile c:\myproject\powershell.config.json

-SSHServerMode |-sshs

在 sshd_config 中用于将 PowerShell 作为 SSH 子系统运行。 它不用于任何其他用途或不受支持。

-STA

使用单线程单元启动 PowerShell。 这是默认值。 此开关仅在 Windows 平台上可用。 在非 Windows 平台上使用此参数会导致错误。

-Version |-v

显示此 PowerShell 可执行文件的版本。 将忽略其他参数。

-WindowStyle |-w

设置会话的窗口样式。 有效值为 Normal、Minimized、Maximized 和 Hidden。 此参数仅适用于 Windows。 在非 Windows 平台上使用此参数会导致错误。

-WorkingDirectory |-wd |-wo

通过在启动时执行来设置初始工作目录。 支持任何有效的 PowerShell 文件路径。

若要在主目录中启动 PowerShell，请使用：pwsh -WorkingDirectory ~

-Help，-?, /？

显示有关 pwsh的帮助。 如果要在 PowerShell 中键入 pwsh 命令，请使用连字符（-），而不是正斜杠（/）前面添加命令参数。