Getting started

Install

npm install -g mobile-repo-doctor

mrd is a short alias for mobile-repo-doctor.

Scan a project

mrd scan .            # scan the current directory
mrd scan ./my-app     # scan a specific path

The scan runs entirely on your machine. There is no account, no upload, and the only network request is an optional check for a newer version on npm (skipped in CI, disable with --no-update-check).

Options

mrd scan [options] <path>

  -o, --output <path>   Output file path (default: ./repo-health-report.html)
  -f, --format <type>   Report format: html, json, md, or comma-separated
  --open                Open the report in your browser after generating
  -v, --verbose         Verbose output
  --no-update-check     Disable the npm update notification

Examples:

mrd scan . -f html --open          # HTML report, opened in the browser
mrd scan . -f json -o report.json  # machine-readable JSON
mrd scan . -f md -o report.md      # Markdown report for an AI assistant
mrd scan . -f html,json,md         # all three at once

See Reports for what each format looks like.

Exit code

The CLI exits with code 1 when it finds any critical or high severity issue, and 0 otherwise. This lets you fail a CI job on serious findings — though the GitHub Action gives you a finer failure policy.