PowerShell/Docs/replace-in-files.md

The replace-in-files.ps1 PowerShell Script

This PowerShell script searches and replaces a pattern in the given files by the replacement.

Parameters

replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-files] <String>] [<CommonParameters>]

-pattern <String>
    Specifies the pattern to look for
    
    Required?                    false
    Position?                    1
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-replacement <String>
    Specifies the replacement
    
    Required?                    false
    Position?                    2
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-files <String>
    Specifies the file to scan
    
    Required?                    false
    Position?                    3
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

[<CommonParameters>]
    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

Example

PS> ./replace-in-files NSA "No Such Agency" C:\Temp\*.txt

Notes

Author: Markus Fleschutz | License: CC0

Related Links

https://github.com/fleschutz/PowerShell

Source Code

<# .SYNOPSIS Search and replace a pattern in the given files by the replacement .DESCRIPTION This PowerShell script searches and replaces a pattern in the given files by the replacement. .PARAMETER pattern Specifies the pattern to look for .PARAMETER replacement Specifies the replacement .PARAMETER files Specifies the file to scan .EXAMPLE PS> ./replace-in-files NSA "No Such Agency" C:\Temp*.txt .LINK https://github.com/fleschutz/PowerShell .NOTES Author: Markus Fleschutz | License: CC0 #>

param([string]$pattern = "", [string]$replacement = "", [string]$files = "")

function ReplaceInFile { param([string]$FilePath, [string]$Pattern, [string]$Replacement)

[System.IO.File]::WriteAllText($FilePath,
    ([System.IO.File]::ReadAllText($FilePath) -replace $Pattern, $Replacement)
)

}

try { if ($pattern -eq "" ) { $pattern = read-host "Enter search pattern" } if ($replacement -eq "" ) { $replacement = read-host "Enter replacement" } if ($files -eq "" ) { $files = read-host "Enter files" }

$StopWatch = [system.diagnostics.stopwatch]::startNew()

$fileList = (get-childItem -path "$files" -attributes !Directory)
foreach($file in $fileList) {
	ReplaceInFile $file $pattern $replacement
}
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"OK, replaced '$pattern' by '$replacement' in $($fileList.Count) files in $Elapsed sec."
exit 0 # success

} catch { "⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])" exit 1 }

Generated by convert-ps2md.ps1 using the comment-based help of replace-in-files.ps1