PSRAFSCAN DOCUMENTATION

Get Started with PSRafScan

Check requirements, obtain the current public alpha, install and verify the module, run a first scan, and troubleshoot PSRafScan on PowerShell 7.4 or later.

Requirements and lifecycle

  • PowerShell 7.4 or later.
  • The current public alpha target is 0.2.0-alpha1.
  • No external PowerShell-module dependency is required.
  • Windows, macOS, and Linux are declared targets. The reviewed active CI evidence validates Windows; current platform-specific checks are still needed for macOS and Linux.

Obtain the current release

Use the exact public GitHub Releases page. Download the release ZIP, extract it, and locate the packaged PSRafScan module folder.

Install the module folder

Copy the extracted PSRafScan folder into a user module path. The folder itself should contain PSRafScan.psd1, PSRafScan.psm1, Public, Private, Rules, SelfTests, Templates, and related module assets.

# Windows user modules
$HOME\Documents\PowerShell\Modules

# macOS and Linux user modules
$HOME/.local/share/powershell/Modules

Verify the installation

Import should complete without an external module installation. Get-Command should resolve RSX as the alias for Invoke-PSRafScan. Review the complete self-test result rather than relying on one success line.

Import-Module PSRafScan
Get-Command RSX
RSX -SelfTest

Run a first review

Use TerminalPaste instead when that exact source is intended for direct terminal entry. Fix parser errors first, inspect all rule findings, revise narrowly, and rescan.

RSX -Path ./script.ps1 -IntendedUse Ps1File -FailOn Warning

Update or remove

To update, close sessions that imported the module, replace the installed module folder with a verified newer release folder, start a fresh PowerShell 7.4+ session, and repeat import and self-test checks.

To remove, close sessions using the module and remove only the installed PSRafScan module folder you previously copied. Do not delete a broader PowerShell Modules directory.

Troubleshooting

  • If Import-Module cannot find PSRafScan, verify the module folder is directly under a path in $env:PSModulePath.
  • If execution policy or downloaded-file marking blocks import, review the exact file origin and your organization's PowerShell policy before changing policy.
  • If self-tests differ, record the PowerShell version, OS, host, installed module path, and exact release source before reporting the problem.
  • Do not treat a passing self-test as proof that an unrelated target script is safe.