Skip to main content

Run an audit

What you need​

  • A copy of your app's repository on your machine. For a Lovable or Emergent app, connect it to GitHub from the platform and clone it.
  • Python 3.11 or later. offramp needs nothing else: no packages to install, no account and no API key.

Run it​

git clone https://github.com/devopsgenie-ai/offramp
python3 offramp/skills/offramp/scripts/audit.py path/to/your-app --out audit-report

This writes two files:

FileFor
audit-report/report.mdYou. Open it in any Markdown viewer, or on GitHub.
audit-report/report.jsonTools. The same content as canonical JSON, schema offramp.audit/1.

Next: read the report.

Options​

audit.py <repo> --out <dir> [--fail-on critical|high|medium|low]
OptionMeaning
<repo>Path to the repository to audit.
--out <dir>Directory for report.md and report.json. Required.
--fail-on <severity>Exit with status 1 when any finding is at or above this severity.

Exit status​

StatusMeaning
0No finding at or above --fail-on. Without --fail-on, always 0.
1At least one finding at or above --fail-on.
2The tool itself failed.

In CI​

Run it on every pull request and fail the build on high or critical findings:

python3 skills/offramp/scripts/audit.py . --out audit-report --fail-on high

The report is byte-stable: the same commit always gives the same report, because it records the commit instead of a timestamp. That makes it safe to keep in the repository and review as a diff.