Add-History

向会话历史记录附加条目。

语法

Add-History
   [[-InputObject] <PSObject[]>]
   [-Passthru]
   [<CommonParameters>]

说明

cmdlet Add-History 会将条目添加到会话历史记录的末尾,即当前会话期间输入的命令列表。

会话历史记录是在会话期间输入的命令的列表。 会话历史记录表示命令的执行顺序、状态以及开始和结束时间。 输入每个命令时,PowerShell 会将其添加到历史记录中,以便可以重复使用它。 有关会话历史记录的详细信息,请参阅 about_History

会话历史记录与 PSReadLine 模块维护的历史记录分开管理。 这两个历史记录在加载 PSReadLine 的会话中可用。 此 cmdlet 仅适用于会话历史记录。 有关详细信息,请参阅 about_PSReadLine

可以使用 Get-History cmdlet 获取命令并将其传递给 Add-History,也可以将命令导出到 CSV 或 XML 文件,然后导入命令,并将导入的文件传递给 Add-History。 可以使用此 cmdlet 向历史记录添加特定命令,或创建单个历史记录文件以保存来自多个会话的命令。

示例

示例 1:将命令添加到不同会话的历史记录

本示例将一个 PowerShell 会话中键入的命令添加到不同 PowerShell 会话的历史记录中。

Get-History | Export-Csv c:\testing\history.csv -IncludeTypeInformation
Import-Csv c:\testing\history.csv | Add-History

第一个命令获取表示历史记录中命令的对象,并将其导出到 文件中 History.csv

第二个命令是在另一个会话的命令行中键入的。 它使用 Import-Csv cmdlet 导入 文件中的对象 History.csv 。 管道运算符 (|) 将对象传递给 Add-History cmdlet,后者会将表示文件中 History.csv 命令的对象添加到当前会话历史记录。

示例 2:导入并运行命令

此示例从 History.xml 文件导入命令,将它们添加到当前会话历史记录,然后在组合历史记录中运行命令。

Import-Clixml c:\temp\history.xml | Add-History -PassThru | ForEach-Object -Process {Invoke-History}

第一个命令使用 Import-Clixml cmdlet 导入已导出到文件的 History.xml 命令历史记录。 管道操作员将命令传递给 Add-History cmdlet,后者会将命令添加到当前会话历史记录。 PassThru 参数在管道中传递表示添加的命令的对象。

然后,该命令使用 ForEach-Object cmdlet 将 Invoke-History 命令应用于组合历史记录中的每个命令。 命令 Invoke-History 的格式设置为脚本块,包含在大括号 ({}) ,这是 cmdlet 的 Process 参数 ForEach-Object 的要求。

示例 3:将历史记录中的命令添加到历史记录的末尾

本示例将历史记录中的前五个命令添加到历史记录列表的末尾。

Get-History -Id 5 -Count 5 | Add-History

cmdlet Get-History 获取以命令 5 结尾的五个命令。 管道运算符将它们传递给 Add-History cmdlet,后者将其追加到当前历史记录。 命令Add-History不包含任何参数,但 PowerShell 会将通过管道传递的对象与 的 Add-HistoryInputObject 参数相关联。

示例 4:将 .csv 文件中的命令添加到当前历史记录

此示例将 文件中的命令 History.csv 添加到当前会话历史记录。

$a = Import-Csv c:\testing\history.csv
Add-History -InputObject $a -PassThru

cmdlet Import-Csv 导入 文件中的命令, History.csv 并将其内容存储在变量 $a中。

第二个命令使用 Add-History cmdlet 将 中的 History.csv 命令添加到当前会话历史记录。 它使用 InputObject 参数来指定 $a 变量和 PassThru 参数来生成一个对象,以在命令行中显示。 如果没有 PassThru 参数,cmdlet Add-History 不会生成任何输出。

示例 5:将 .xml 文件中的命令添加到当前历史记录

此示例将 文件中的命令 history.xml 添加到当前会话历史记录。

Add-History -InputObject (Import-Clixml c:\temp\history.xml)

InputObject 参数将括号中命令的结果传递给 Add-History cmdlet。 括号中的命令首先执行,将 history.xml 文件导入 PowerShell。 然后,该 Add-History cmdlet 将文件中的命令添加到会话历史记录。

参数

-InputObject

指定要作为 HistoryInfo 对象添加到会话历史记录的条目数组。 可以使用此参数将 HistoryInfo 对象(例如 、 Import-ClixmlImport-Csv cmdlet 返回Get-History的对象)提交到 Add-History

Type:PSObject[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Passthru

指示此 cmdlet 为每个历史记录项返回一个 HistoryInfo 对象。 默认情况下,此 cmdlet 将不产生任何输出。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

HistoryInfo

可以通过管道将 HistoryInfo 对象传递给此 cmdlet。

输出

None or Microsoft.PowerShell.Commands.HistoryInfo

如果指定 PassThru 参数,此 cmdlet 将返回 HistoryInfo 对象。 否则,此 cmdlet 将不生成任何输出。

备注

会话历史记录是会话期间输入的命令以及 ID 的列表。 会话历史记录表示命令的执行顺序、状态以及开始和结束时间。 输入每个命令时,PowerShell 会将其添加到历史记录中,以便可以重复使用它。 有关会话历史记录的详细信息,请参阅 about_History

若要指定要添加到历史记录中的命令,请使用 InputObject 参数。 该 Add-History 命令仅接受 HistoryInfo 对象,例如 cmdlet 为每个命令返回的对象 Get-History 。 不能向其传递路径和文件名,也不能传递命令列表。

可以使用 InputObject 参数将 HistoryInfo 对象的文件传递给 Add-History。 为此,请使用 或 Export-Clixml cmdlet 将命令的结果Get-History导出到文件Export-Csv,然后使用 或 Import-Clixml cmdlet 导入文件Import-Csv。 然后,可以通过管道或变量将导入的 HistoryInfo 对象的 Add-History 文件传递到 。 有关详细信息,请参阅示例。

传递给 Add-History cmdlet 的 HistoryInfo 对象的文件必须包括类型信息、列标题和 HistoryInfo 对象的所有属性。 如果打算将对象传递回 Add-History,请不要使用 cmdlet 的 Export-CsvNoTypeInformation 参数,也不要删除文件中的类型信息、列标题或任何字段。

若要修改会话历史记录,请将会话导出到 CSV 或 XML 文件,修改文件,导入文件,并使用 Add-History 将其追加到当前会话历史记录。