PSRafScan CLI Reference - PSRafScan Documentation

Public commands

Exported PSRafScan commands
Command	Purpose
`Invoke-PSRafScan`	Run the guided workflow, direct scan, catalog listing, or self-test entry point.
`RSX`	Alias for Invoke-PSRafScan.
`Get-PSRafScanRule`	List and filter rule metadata.
`Get-PSRafScanSelfTest`	List and filter self-test metadata.
`Invoke-PSRafScanSelfTest`	Run the self-test suite and format its result.

Direct scan parameters

Verified direct scan parameters
Parameter	Accepted values or behavior	Default
`Path`	Existing file path; mutually exclusive with Clipboard	None
`Clipboard`	Use current raw clipboard text; mutually exclusive with Path	Off
`IntendedUse`	Ps1File or TerminalPaste	Ps1File for direct scans
`FailOn`	Any, Warning, Error, or None	Warning for direct scans
`OutputFormat`	PlainText or Json	PlainText
`OutputPath`	Write report to the supplied path	Return report to caller
`HideInformationDetail`	Reduce Information detail in PlainText	Off
`NoColor`	Disable terminal color where used	Off
`NonInteractive`	Prevent guided flow	Off

Catalog and self-test switches

Use SelfTest, ListRules, ListSelfTests, or Help to select a non-scan operation. The rule and self-test catalog surfaces accept filters for names, categories, severity, intended use, tags, aliases, search text, deprecation state, and related metadata where supported by that command.

RSX -ListRules -Tag git
Get-PSRafScanRule -Category CredentialSafety -Severity Warning
Get-PSRafScanSelfTest -RuleName UnapprovedVerb -TestKind Negative
RSX -SelfTest
RSX -Help

Verified command examples

RSX -Path ./script.ps1 -IntendedUse Ps1File -FailOn Warning
RSX -Clipboard -IntendedUse TerminalPaste -FailOn Warning
RSX -Path ./script.ps1 -IntendedUse Ps1File -FailOn Error -OutputFormat Json -OutputPath ./result.json

Declared switches not documented as functional here

The current public function declares UseNativeEngine and OpenInVSCode. Current review does not establish a distinct, reliable direct-scan behavior for these switches, so this reference does not tell users to depend on them.