Update the comment based help

This commit is contained in:
Markus Fleschutz 2021-10-15 23:09:08 +02:00
parent b8189c6ba4
commit ae5a828ec2
35 changed files with 90 additions and 52 deletions

View File

@ -29,7 +29,7 @@ try {
[int]$Step = 1
foreach ($Folder in $Folders) {
$FolderName = (get-item "$Folder").Name
"👉 Step $Step/$($FolderCount): Cleaning 📂$($FolderName)..."
"⏳ Cleaning 📂$FolderName (step $Step/$($FolderCount))..."
& git -C "$Folder" clean -xfd -f # force + recurse into dirs + don't use the standard ignore rules
if ($lastExitCode -ne "0") { throw "'git clean -xfd -f' failed" }

View File

@ -17,16 +17,16 @@ try {
$StopWatch = [system.diagnostics.stopwatch]::startNew()
if ($IsLinux) {
"Step 1/4: Fetching update infos for installed Debian packages..."
"Fetching update infos for installed Debian packages (step 1/4)..."
& sudo apt update
"Step 2/4: Upgrading installed Debian packages..."
"Upgrading installed Debian packages (step 2/4)..."
& sudo apt upgrade --yes
"Step 3/4: Removing obsolete Debian packages..."
"Removing obsolete Debian packages (step 3/4)..."
& sudo apt autoremove --yes
"Step 4/4: Upgrading installed Snap packages..."
"Upgrading installed Snap packages (step 4/4)..."
& sudo snap refresh
} else {
"Sorry, not supported yet"

View File

@ -3,8 +3,10 @@
Lists all branches in a Git repository
.DESCRIPTION
list-branches.ps1 [<RepoDir>] [<SearchPattern>]
<RepoDir> is the current working directory by default
<SearchPattern> is "*" (anything) by default
.PARAMETER RepoDir
Specifies the path to the Git repository (current working directory by default)
.PARAMETER SearchPattern
Specifies the search patter (anything by default)
.EXAMPLE
PS> ./list-branches
.NOTES

View File

@ -1,8 +1,8 @@
<#
.SYNOPSIS
Lists all local drives.
Lists all local drives
.DESCRIPTION
list-drives.ps1
This script lists the details of all local drives.
.EXAMPLE
PS> ./list-drives

View File

@ -3,7 +3,6 @@
Lists major earthquakes for the last 30 days
.DESCRIPTION
Lists earthquakes with magnitude >= 6.0 for the last 30 days
list-earthquakes.ps1
.EXAMPLE
PS> ./list-earthquakes
.NOTES

View File

@ -2,8 +2,9 @@
.SYNOPSIS
Lists empty subfolders within a directory tree
.DESCRIPTION
list-empty-dirs.ps1 [<DirTree>]
<DirTree> is the path to the directory tree
This script scans and lists all empty subfolders within the given directory tree.
.PARAMETER DirTree
Specifies the path to the directory tree
.EXAMPLE
PS> ./list-empty-dirs C:\
.NOTES

View File

@ -2,8 +2,9 @@
.SYNOPSIS
Lists empty files within a directory tree
.DESCRIPTION
list-empty-files.ps1 [<DirTree>]
<DirTree> is the path to the directory tree
This script scans and lists all empty files within the given directory tree.
.PARAMETER DirTree
Specifies the path to the directory tree
.EXAMPLE
PS> ./list-empty-files C:\
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all environment variables
.DESCRIPTION
list-environment-variables.ps1
This script lists all environment variables.
.EXAMPLE
PS> ./list-environment-variables

View File

@ -3,7 +3,8 @@
Lists the exchange rates for a currency
.DESCRIPTION
Lists the current exchange rates for the given currency (USD per default).
list-exchange-rates.ps1 [<currency>]
.PARAMETER currency
Specifies the base currency
.EXAMPLE
PS> ./list-exchange-rates EUR
.NOTES

View File

@ -2,8 +2,9 @@
.SYNOPSIS
Lists all files in a directory tree
.DESCRIPTION
list-files.ps1 [<DirTree>]
<DirTree> is the path to the directory tree
This script lists all files within the given directory tree.
.PARAMETER DirTree
Specifies the path to the directory tree
.EXAMPLE
PS> ./list-files C:\
.NOTES

View File

@ -2,7 +2,11 @@
.SYNOPSIS
Lists the phone calls of the FRITZ!Box device
.DESCRIPTION
list-fritzbox-calls.ps1 [<Username>] [<Password>]
This script lists the phone calls of the FRITZ!Box device.
.PARAMETER Username
Specifies the user name for FRITZ!Box
.PARAMETER Password
Specifies the password to FRITZ!Box
.EXAMPLE
PS> ./list-fritzbox-calls
.NOTES

View File

@ -2,7 +2,11 @@
.SYNOPSIS
Lists FRITZ!Box's known devices
.DESCRIPTION
list-fritzbox-devices.ps1 [<Username>] [<Password>]
This script lists FRITZ!Box's known devices.
.PARAMETER Username
Specifies the user name to FRITZ!Box
.PARAMETER Password
Specifies the password to FRITZ!Box
.EXAMPLE
PS> ./list-fritzbox-devices
.NOTES

View File

@ -2,8 +2,9 @@
.SYNOPSIS
Lists hidden files in a directory tree
.DESCRIPTION
list-hidden-files.ps1 [<DirTree>]
<DirTree> is the path to the directory tree
This script scans and lists all hidden files in a directory tree.
.PARAMETER DirTree
Specifies the path to the directory tree
.EXAMPLE
PS> ./list-hidden-files C:\
.NOTES

View File

@ -2,8 +2,7 @@
.SYNOPSIS
Lists the installed apps
.DESCRIPTION
Lists the installed apps (from Windows Store or snaps).
list-installed-apps.ps1
This script lists the installed apps (from Windows Store or snaps).
.EXAMPLE
PS> ./list-installed-apps
.NOTES

View File

@ -2,7 +2,9 @@
.SYNOPSIS
Lists the latests tags in all Git repositories in a folder
.DESCRIPTION
list-latest-tags.ps1 [<ParentDir>]
This script lists the latest tags in all Git repositories in the specified folder.
.PARAMETER ParentDir
Specifies the path to the parent folder
.EXAMPLE
PS> ./list-latest-tags C:\MyRepos
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all memos in $HOME/Memos.csv
.DESCRIPTION
list-memos.ps1
This script lists all memo entries in Memos.csv in the home folder.
.EXAMPLE
PS> ./list-memos
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all PowerShell modules
.DESCRIPTION
list-modules.ps1
This script lists all installed PowerShell modules.
.EXAMPLE
PS> ./list-modules

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all tables of a MySQL database
.DESCRIPTION
list-mysql-tables.ps1
This script lists all tables of the given MySQL database.
.EXAMPLE
PS> ./list-mysql-tables
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all network shares of the local computer
.DESCRIPTION
list-network-shares.ps1
This script lists all network shares of the local computer.
.EXAMPLE
PS> ./list-network-shares

View File

@ -2,7 +2,11 @@
.SYNOPSIS
Lists the latest news
.DESCRIPTION
list-news.ps1 [<RSS-URL>] [<max-count>]
This script lists the latest RSS feed news.
.PARAMETER RSS_URL
Specifies the URL to the RSS feed
.PARAMETER MaxCount
Specifies the number of news to list
.EXAMPLE
PS> ./list-news
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists OS releases and download URL
.DESCRIPTION
list-os-releases.ps1
This script lists OS releases and download URL.
.EXAMPLE
PS> ./list-os-releases
.NOTES

View File

@ -2,7 +2,11 @@
.SYNOPSIS
Lists the latest operating system updates
.DESCRIPTION
list-os-updates.ps1 [<RSS-URL>] [<max-count>]
This script lists the latest operating system update news.
.PARAMETER RSS_URL
Specifies the URL to the RSS feed
.PARAMETER MaxCount
Specifies the number of news to list
.EXAMPLE
PS> ./list-os-updates
.NOTES

View File

@ -1,8 +1,14 @@
<#
.SYNOPSIS
Prints a list of random passwords
Lists random passwords
.DESCRIPTION
list-passwords.ps1 [<PasswordLength>] [<Columns>] [<Rows>]
This script lists random passwords.
.PARAMETER PasswordLength
Specifies the length of the password
.PARAMETER Columns
Specifies the number of columns
.PARAMETER Rows
Specifies the number of rows
.EXAMPLE
PS> ./list-passwords
.NOTES

View File

@ -1,8 +1,14 @@
<#
.SYNOPSIS
Prints a list of random PIN's
Lists random PIN's
.DESCRIPTION
list-pins.ps1 [<PinLength>] [<Columns>] [<Rows>]
This script lists random PIN's.
.PARAMETER PinLength
Specifies the PIN length
.PARAMETER Columns
Specifies the number of columns
.PARAMETER Rows
Specifies the number of rows
.EXAMPLE
PS> ./list-pins
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all jobs of all printers
.DESCRIPTION
list-print-jobs.ps1
This script lists all print jobs of all printer devices.
.EXAMPLE
PS> ./list-print-jobs
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all printers known to the local computer
.DESCRIPTION
list-printers.ps1
This script lists all printers known to the local computer.
.EXAMPLE
PS> ./list-printers
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all local computer processes
.DESCRIPTION
list-processes.ps1
This script lists all local computer processes.
.EXAMPLE
PS> ./list-processes

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists the user's PowerShell profiles
.DESCRIPTION
list-profiles.ps1
This script lists the user's PowerShell profiles.
.EXAMPLE
PS> ./list-profiles

View File

@ -2,7 +2,9 @@
.SYNOPSIS
Lists the details of all Git repositories in a folder
.DESCRIPTION
list-repos.ps1 [<ParentDir>]
This script lists the details of all Git repositories in the given folder.
.PARAMETER ParentDir
Specifies the path to the parent folder.
.EXAMPLE
PS> ./list-repos C:\MyRepos

View File

@ -2,8 +2,7 @@
.SYNOPSIS
Lists all PowerShell scripts in this repository
.DESCRIPTION
Lists all PowerShell scripts in this repository (sorted alphabetically)
list-scripts.ps1
This script lists all PowerShell scripts in the repository (sorted alphabetically).
.EXAMPLE
PS> ./list-scripts
.NOTES

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists the local computer services
.DESCRIPTION
list-services.ps1
This script lists all local computer services.
.EXAMPLE
PS> ./list-services

View File

@ -2,8 +2,7 @@
.SYNOPSIS
Lists all tables of a SQL server database
.DESCRIPTION
Lists all tables in a SQL server database and exports the list as CSV
Lists all tables in a SQL server database and exports the list as CSV.
Install-Module InvokeQuery
Run the above command if you do not have this module.
.EXAMPLE

View File

@ -2,8 +2,9 @@
.SYNOPSIS
Lists the submodules of a Git repository
.DESCRIPTION
list-submodules.ps1 [<RepoDir>]
<RepoDir> is the path to the repository (current working dir by default)
This script lists the submodules of the given Git repository.
.PARAMETER RepoDir
Specifies the path to the repository (current working dir by default)
.EXAMPLE
PS> ./list-submodules C:\MyRepo
.NOTES

View File

@ -2,9 +2,11 @@
.SYNOPSIS
Lists all tags in a Git repository
.DESCRIPTION
list-tags.ps1 [<RepoDir>] [<SearchPattern>]
<RepoDir> is the path to the Git repository
<SearchPattern> is "*" (anything) by default
This script lists all tags in the given Git repository.
.PARAMETER RepoDir
Specifies the path to the Git repository
.PARAMETER SearchPattern
Specifies the search pattern (anything by default)
.EXAMPLE
PS> ./list-tags C:\MyRepo

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all Windows scheduler tasks
.DESCRIPTION
list-tasks.ps1
This script lists all Windows scheduler tasks.
.EXAMPLE
PS> ./list-tasks