PowerShell/docs/list-scripts.md

74 lines
1.9 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*list-scripts.ps1*
================
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
list-scripts.ps1 [[-category] <string>]
2021-10-17 14:33:27 +02:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-10-17 14:33:27 +02:00
```powershell
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-10-19 08:12:00 +02:00
Lists the PowerShell scripts
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-10-19 08:12:00 +02:00
This PowerShell script lists the Mega collection of PowerShell scripts (sorted alphabetically and optionally by category).
.PARAM category
Specifies the desired category: audio, desktop, filesystem, fun, git, misc, or: * (default)
2022-11-17 20:02:26 +01:00
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./list-scripts.ps1
2023-10-19 08:12:00 +02:00
No Script Category Description
-- ------ -------- -----------
1 add-firewall-rules.ps1 misc Adds firewall rules for executables (needs admin rights)
...
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-10-19 08:12:00 +02:00
param([string]$category = "*")
function ListScripts([string]$category) {
Write-Progress "Loading data from ../Data/script.csv..."
$table = Import-CSV "$PSScriptRoot/../Data/scripts.csv"
2023-05-26 12:20:18 +02:00
[int]$No = 1
foreach($row in $table) {
2023-10-19 08:12:00 +02:00
if ($row.CATEGORY -like $category) {
New-Object PSObject -Property @{
'No' = $No++
'Script' = $row.SCRIPT
'Category' = $row.CATEGORY
'Description' = $row.DESCRIPTION
}
2022-11-17 20:02:26 +01:00
}
}
2023-10-19 08:12:00 +02:00
Write-Progress -completed " "
2022-11-17 20:02:26 +01:00
}
try {
2023-10-19 08:12:00 +02:00
ListScripts $category | Format-Table -property No,Script,Category,Description
2023-09-20 17:05:11 +02:00
# $files = Get-ChildItem -path "./*.ps1" -attributes !Directory
# foreach ($file in $files) {
# $help = Get-Help $file -full
2023-10-19 08:12:00 +02:00
# Write-Output "$($file.Name), ,`"$($help.Synopsis)`","
2023-09-20 17:05:11 +02:00
# }
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-10-19 08:12:00 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of list-scripts.ps1 as of 10/19/2023 08:11:40)*