Documentation

Learn how to use Production Audit System to catch production gaps before they ship.

Getting Started

Install PRAS and run your first audit

CLI Reference

Complete command-line interface documentation

UX & Polish Audit

Learn about UX layer detection capabilities

GitHub Integration

Set up the GitHub App for automated audits

Getting Started

Installation

Install PRAS globally using npm:

npm install -g @te-code/production-audit

Or use it directly with npx:

npx @te-code/production-audit audit ./my-app

Run Your First Audit

Audit your project directory:

pras audit ./my-app

Include UX & Polish checks:

pras audit ./my-app --ux

CLI Reference

pras audit <path>

Audit a single project for production readiness

--uxInclude UX & Polish layer checks
--ux-staticRun only static UX checks (fastest)
--ux-allRun all UX checks including dynamic (requires Playwright)
--format, -fOutput format: console, json, markdown, sarif, llm-json, llm-markdown
--output, -oWrite results to file instead of stdout
pras fix <path>

Automatically fix safe issues

--tierAuto-fix tier: 1 (safe only), 2 (with confirmation), 3 (all)
--dry-runPreview fixes without applying them
pras create-issues <path>

Create GitHub issues for detected gaps

--repoGitHub repository (owner/repo)
--min-severityMinimum severity to create issues for

UX & Polish Audit

The UX & Polish audit layer uses a three-tier approach to detect user experience issues:

Static Layer (AST-based, < 5s)

  • Missing loading states (useQuery/useSWR)
  • Missing Suspense boundaries
  • Missing error boundaries
  • Images without alt text
  • Hardcoded CSS values

Build Layer (Filesystem, < 30s)

  • Favicon and manifest validation
  • SEO meta tag completeness
  • Link integrity checks
  • robots.txt and sitemap.xml

Dynamic Layer (Playwright, < 2min)

  • Core Web Vitals (INP, CLS)
  • Mobile overflow detection
  • Accessibility violations (axe-core)
  • Flash of Unstyled Content

GitHub Integration

Install the PRAS GitHub App to automatically audit pull requests:

  1. Install the GitHub App on your repositories
  2. Configure which checks to run in your .pras.yml file
  3. PRAS will automatically audit new pull requests
  4. View results in the GitHub Security tab (SARIF format)

Additional Resources

GitHub Repository

View source code, report issues, and contribute

API Documentation

REST API reference for programmatic access

Dashboard

View audit history and analytics

Community Support

Get help from the community