PowerShell/Docs/check-symlinks.md

38 lines
1.1 KiB
Markdown
Raw Normal View History

2021-11-08 21:36:42 +01:00
## check-symlinks.ps1 - Checks every symlink in a folder (including subfolders)
This script checks every symlink in a folder (including subfolders).
Returns the number of broken symlinks as exit value.
## Parameters
```powershell
/home/markus/Repos/PowerShell/Scripts/check-symlinks.ps1 [[-folder] <String>] [<CommonParameters>]
-folder <String>
Specifies the path to the directory tree
Required? false
Position? 1
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
```powershell
PS> ./check-symlinks .
✔️ 0 out of 10 symlinks are broken in 📂/home/markus
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of check-symlinks.ps1*