PSRafScan Documentation

Use first-party PSRafScan guides to get started, run a scan, choose intended use, read reports, review generated code, and author rules and self-tests.

Start here

New users should begin with Getting Started, then follow Run a Scan. Choose the intended use before interpreting findings.

GUIDE 01

Getting Started

Requirements, public alpha availability, installation, verification, and a first scan.

Open page GUIDE 02

Run a Scan

Review an existing path or clipboard content with explicit context, threshold, format, and destination.

Open page GUIDE 03

Intended Use

Choose Ps1File or TerminalPaste and understand the six terminal-paste-only rules.

Open page GUIDE 04

Guided Terminal Workflow

Use RSX without flags for the guided input, context, threshold, output, and review sequence.

Open page GUIDE 05

CLI Reference

Reference verified public functions, the RSX alias, scan settings, and catalog filters.

Open page GUIDE 06

Reports and Exit Codes

Understand report fields, severity, FailOn, and implemented process results 0, 1, and 2.

Open page GUIDE 07

AI-Generated PowerShell

Preserve the candidate, request bounded revisions, review a diff, rescan, and decide on testing.

Open page GUIDE 08

Custom Rules and Self-Tests

Use the included templates to create a rule, positive and negative cases, and expected results.

Open page

Documentation reviewed 2026-07-12 against PSRafScan 0.2.0-alpha1at commit c9d2a8588d042eef021d43edc2e4586318df1482. Source can change after this review.