--- name: powershell-600348c4d64e description: > PowerShell 7+ scripting reference. Trigger on .ps1, .psm1, .psd1 files, debugging PowerShell errors, shell automation, CI/CD pipelines, or credential security. testing. Only PS 7+ — no 5.1 legacy. --- # PowerShell Scripting Skill ## Quick Reference | Need | Pattern | |------|---------| | Script header | `#Requires -Version 7.0` + `Set-StrictMode -Version Latest` + `$ErrorActionPreference = 'Stop'` | | Pipeline data output | `Write-Output` (never `Write-Host` for data the caller may consume) | | User-facing status | `Write-Host` or `Write-Information` | | State-changing function | `[CmdletBinding(SupportsShouldProcess)]` + `$PSCmdlet.ShouldProcess()` | | Native command errors | `$ErrorActionPreference = 'Stop'` → throws automatically | | Secrets / credentials | `SecretManagement` + `SecretStore` or env vars — never hardcode; avoid `SecureString` | | Path construction | `Join-Path` — never string concatenation | | Wildcard-safe paths | `-LiteralPath` instead of `-Path` | | Platform detection | `$IsWindows` / `$IsLinux` / `$IsMacOS` | | Parallel processing | `ForEach-Object -Parallel` | | Null-conditional | `??` and `?.` operators | | Office/Word COM | Avoid by default; for Word tasks prefer `nong word ...`. If COM is explicitly required, read `../references/word-com-automation.md` first | | Module import | `Import-Module -MinimumVersion X.Y -ErrorAction Stop` | | Verb-noun naming | Use approved verbs from `Get-Verb`; run PSScriptAnalyzer `UseApprovedVerbs` | | Comment-based help | Required for public functions/scripts: `.SYNOPSIS`, `.DESCRIPTION`, `.PARAMETER`, `.EXAMPLE` | ## Scope **PowerShell 7+ only.** No 5.1 support. ## Environment & Execution - **Windows**: `pwsh -NoLogo -NoProfile -ExecutionPolicy Bypass -File ./script.ps1` - **WSL**: `pwsh.exe ...` (same flags), use `wslpath -w` for path conversion - **Linux / macOS**: `pwsh` (same flags) `-ExecutionPolicy Bypass` is acceptable in dev/CI. In production, prefer `RemoteSigned` or signing. ExecutionPolicy is **Windows-only** — on Linux/macOS it is effectively `Unrestricted`. ## Script Header ```powershell #Requires -Version 7.0 Set-StrictMode -Version Latest $ErrorActionPreference = 'Stop' ``` Plus comment-based help for every public script/function: ```powershell <# .SYNOPSIS Short description. .DESCRIPTION More detailed description. .PARAMETER Param1 Explanation of Param1. .EXAMPLE .\script.ps1 -Param1 value .NOTES Author : Your Name Version : 1.0.0 #> ``` ## Cmdlet / Function Conventions ```powershell function Invoke-Deployment { [CmdletBinding(SupportsShouldProcess, ConfirmImpact='High')] param( [Parameter(Mandatory, ValueFromPipeline)] [string]$TargetPath, [Parameter()] [ValidateSet('dev','staging','prod')] [string]$Environment = 'dev', [switch]$Force ) process { if ($PSCmdlet.ShouldProcess($TargetPath, "Deploy to $Environment")) { # actual work } } } ``` - Verb-Noun naming using [approved verbs](https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands). - Always add `[CmdletBinding()]` when the function needs `-Verbose`/`-WhatIf` or pipeline input. - Use `[Parameter(Mandatory)]` over manual `if (-not $Param)` checks. - Add `[ValidateSet]`, `[ValidateNotNullOrEmpty]`, `[ValidateRange]` where applicable. ## Dry-Run (WhatIf) ```powershell function Remove-OldFiles { [CmdletBinding(SupportsShouldProcess)] param([string]$Path) Get-ChildItem $Path | ForEach-Object { if ($PSCmdlet.ShouldProcess($_.FullName, 'Remove')) { Remove-Item $_.FullName -Force } } } ``` Always add `SupportsShouldProcess` on functions that modify state. ## Security Checklist - [ ] No hardcoded credentials, tokens, or connection strings. - [ ] All user input validated via `[ValidateSet]`, `[ValidateRange]`, or explicit guards. - [ ] No `Invoke-Expression` with untrusted input. - [ ] `SupportsShouldProcess` on any function that modifies state. - [ ] Secrets from environment variables, `SecretManagement` vaults, or credential stores — not literals. - [ ] `SecureString` avoided for new development. - [ ] Scripts pass PSScriptAnalyzer default rules with no warnings. ## Behavioral Conventions - Always save `.ps1` files as **UTF-8 with BOM**. Always specify `-Encoding UTF8` for file I/O. - Run `[CmdletBinding()]` functions with `-WhatIf` first to preview changes. - Prefer `-LiteralPath` over `-Path` when paths may contain wildcard characters. - Keep scripts idempotent — re-running should be safe. - Include comment-based help for all public functions and scripts. - Use `Get-Verb` and PSScriptAnalyzer `UseApprovedVerbs` to validate verb naming. - Include Pester tests when publishing modules. ## Reference Index | Topic | File | Read when | |-------|------|-----------| | File encoding (UTF-8, BOM, 中文乱码) | [`references/file-encoding.md`](references/file-encoding.md) | Chinese/non-ASCII characters appear garbled; setting up encoding defaults | | Error handling (try/catch, retry, logging) | [`references/error-handling.md`](references/error-handling.md) | Need retry logic, logging patterns, or error propagation rules | | Modules & testing (psd1, Pester, PSScriptAnalyzer) | [`references/modules.md`](references/modules.md) | Building a module, setting up tests, or running PSScriptAnalyzer | | Output & pipeline patterns | [`references/output-pipeline.md`](references/output-pipeline.md) | Choosing Write-Output vs Write-Host, building pipelines, parallel processing | | Credential & secret handling | [`references/credentials.md`](references/credentials.md) | Handling tokens, API keys, or credentials securely | | Path handling & Join-Path | [`references/path-handling.md`](references/path-handling.md) | Building cross-platform paths, dealing with wildcard characters | --- Source attribution: angri450 Original project: https://github.com/angri450/Nong.Dev.Net/blob/db2d8b8376ec529f745fb836c7838e793d5935eb/powershell/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS # Mega AI Hub resource metadata Creator / publisher: angri450 Original project: https://github.com/angri450/Nong.Dev.Net/blob/db2d8b8376ec529f745fb836c7838e793d5935eb/powershell/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: Backend Developer, DevOps / SRE, QA / Test Engineer Specialties: API, DevOps, Word Documents, Frontend, Testing Tools: Tool not specified Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 308a999d3316be9daf05791bc721a47156089a6d101c46cc417e8b6f05d52ea9