How it works

This site is automatically generated from repositories in the Gitea organization PSScripts (plus any additional scripts manually listed in catalog.yml) and exists to make it easy to find an existing script before you write a new one.

Pipeline

1. A scheduled job (Gitea Actions) periodically walks every repository in the PSScripts organization.
2. In each repository it looks for *.ps1 files.
3. It extracts the script description from the standard PowerShell comment-based help header (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .NOTES, .TAGS).
4. The repository name becomes the category name (e.g. NetworkTools → Network Tools) and its Gitea description is shown on the landing page.
5. Scripts with an incomplete or missing header are additionally listed on the Problematic scripts page, so it's clear what needs to be filled in.
6. The optional catalog.yml file at the repo root can add whole categories of hand-entered scripts (never scanned from Gitea) and exclude specific auto-scanned scripts from the catalog entirely — see the project README for the schema.
7. From this information it builds the site and deploys the updated version.

Example of an expected script header

<#
.SYNOPSIS
    Short one-line description of the script.

.DESCRIPTION
    Longer description of what the script does and what it's for.

.PARAMETER Name
    Description of the Name parameter.

.EXAMPLE
    .\Muj-Skript.ps1 -Name "test"

.NOTES
    Author: Jan Novák

.TAGS
    network, monitoring
#>

param(
    [string]$Name
)

A script that's missing .SYNOPSIS or .DESCRIPTION (even a partially filled header) shows up on the Problematic scripts page until the header is completed.

Go straight to the category catalog →