Getting Started

Quick Start

Go from zero to a full production-readiness report in under five minutes. This guide walks through a complete interactive session.

1. Start a scan

Run DeployReady against your project directory. It launches an interactive menu where you can choose to scan, configure an AI model, or learn how it works.

terminal
$ npx deployready@latest ./my-app

  What would you like to do?
   1  Scan this project now            (recommended)
   2  Set up or change the AI model
   3  How does DeployReady work?
   4  Go to the command prompt
   5  Exit

  Pick a number: 1

2. Review the readiness score

DeployReady parses your code, runs static analysis, optionally tests your running app, and produces a 0–100 readiness score with a breakdown by severity.

terminal
✦ Parsing codebase...              done in 0.8s
✦ Running static analysis...        done in 2.3s
✦ Testing localhost app...          done in 4.1s
✦ Analyzing with AI...              done in 6.2s

Production Readiness Score: 0 / 100

🔴 16 critical issues found
🟡 0 warnings
🔵 0 suggestions

3. Inspect findings

Use the interactive command prompt to list issues and drill into any individual finding for full details, the offending code snippet, and fix guidance.

terminal
deployready › issues
  Finding #1:  [CRITICAL] Hardcoded secret / credential in source
  Finding #2:  [CRITICAL] Missing security header
  ...

deployready › show 1
  Full details, code snippet, and fix guidance

4. Apply a fix

Ask DeployReady to fix a finding. It proposes a diff, you approve it, and a backup is created automatically before any change is written.

terminal
deployready › fix 1
  AI-proposed fix applied. Backup created.

deployready › verify 1
  Re-running checks... ✓ Fixed!

Always review fixes

AI-proposed fixes are suggestions. Review every diff before approving and re-run your own tests. See the Security Disclaimer.

5. Export a report

Save your results as a Markdown report or open the HTML dashboard.

terminal
deployready › export
  Report saved to deployready-report.md

deployready › open
  Opening HTML dashboard...

Run non-interactively

For scripting and CI, run a one-shot analysis with flags instead of the interactive menu.

terminal
# One-shot analysis
npx deployready@latest analyze ./my-app

# Skip AI, export a report, fail on critical issues
npx deployready@latest analyze . --no-ai --export --fail-on critical

Common flags

  • --no-ai — run static + dynamic checks only
  • --no-dynamic — skip live localhost testing
  • --export — write a Markdown report
  • --html — generate the HTML dashboard
  • --json — output machine-readable JSON
  • --fail-on critical — exit non-zero to block CI

See it in action

Prefer to watch first? Check out the Demo for a full walkthrough video.
PreviousInstallationNextDemo