StrixScripts/templates/script-template.md

<script-name>.sh

<One or two sentence summary — same tone as the README entry, but here you can go into more detail immediately.>

What it does

<Explain what the script does step by step, in prose. If it touches external systems (network, filesystem paths outside the repo, remote hosts, cron), say so explicitly here — a reader deciding whether to run this needs to know the blast radius before they run it.>

Requirements

• <External commands the script depends on, e.g. curl, jq, ssh>
• <Any required environment variables, config files, or permissions>

Usage

./<path-to-script>/<script-name>.sh [OPTIONS]

Options

Option	Description
-h, --help	Show help message and exit
<flag>

Examples

# <what this example does>
./<script-name>.sh

# <what this example does>
./<script-name>.sh --example value

Notes / Caveats

<Anything non-obvious: destructive operations, required order relative to other scripts, assumptions about the environment it runs in, known limitations. If there's nothing notable, delete this section — don't leave a placeholder "None" in real docs.>