Documentation

Start with a scan.Choose your boundary.

repyy reads repository files as data and gives you a private review report. Use this page for the quick path, then open a focused guide when you need exact flags, configuration, isolation, or coverage details.

Read onlyTarget code stays unexecutedLocalReports stay with youExplicitNetwork and updates are opt in

What repyy does not do

It does not install packages, build the target, run tests, execute source, or upload your code.

Run your first scan

Install repyy on the computer where you will review the code. A local folder needs repyy only. Git is needed for a remote URL in host mode.

Install with Homebrew

brew install --cask Kevin-Umali/tap/repyy

Scan and save HTML

repyy scan ./repository --format html --output report.html

Open report.html directly from your file manager. It is self-contained and works as a local file:// page; a remote source link may open the provider website in your browser.

Install on macOS, Linux, or Windows →

Copyable starting points

Replace the sample path or URL with a target you are allowed to inspect. Review the result before opening the repository in a trusted workspace.

Local folder

Review downloaded code

No Git or network is needed.

repyy scan ./assignment

Remote URL

Inspect before checkout

Host mode needs Git on PATH.

repyy scan https://github.com/org/repo

Automation

Save structured output

JSON and SARIF fit existing review tools.

repyy scan ./repo --format sarif --output report.sarif

Isolation

Use Docker

Pull the signed, digest-pinned release image first.

repyy scan ./repo --sandbox=docker

See all CLI recipes →

Read the result

The verdict is a review decision aid, not a safety certificate. Check coverage before acting on any result.

No findings

No enabled rule matched within completed coverage.

Review required

Findings need a person to inspect their context.

Do not run

High-confidence critical behavior needs a controlled decision before execution.

Scan incomplete

A timeout, limit, permission, clone, archive, or read error reduced coverage. Exit code is 2.

Follow the review workflow →

Choose a report

TerminalPrioritized human review--format terminal

JSONAutomation and saved input--format json

SARIFCode-scanning integrations--format sarif

HTMLPrivate offline review--format html

Render a saved JSON scan

repyy report report.scan.json --format html --output report.html

HTML reports are rendered by the host, including after Docker scans. Keep report files private because paths and evidence can still reveal repository structure.

Compare output formats and flags →

Know the boundary

Local scans need no network. Remote host scans fetch the URL you request with Git; Docker separates HTTPS fetching from network-disabled analysis. Intelligence updates happen only when you run the update command. Provider credentials stay in the process environment and out of URLs.

Need a stronger boundary?

Use the built-in Docker backend, or follow the manual Windows Sandbox, macOS UTM, and Linux QEMU workflows in the isolation guide. --sandbox=vm and --sandbox=auto are reserved for a later release.

Read isolation details →

What “intel” means

Intel means threat intelligence: a dated, signed offline snapshot of sourced package/version advisories and exact file hashes. It is separate from repyy’s built-in behavioral rules, and a match is a reason to review rather than proof by itself.

Built-in rulesFind suspicious behavior and context in source, manifests, automation, and metadata.

Intel snapshotAdds sourced package/version and exact hash indicators.

Check the active snapshot

repyy intel status

Read the complete intelligence guide →

Give your coding agent a safe first step

The optional repyy agent skill tells a coding agent to scan unfamiliar repositories before execution, keep source local, and treat incomplete coverage as unresolved. It installs instructions only; the repyy CLI is installed separately.

Install for Codex

npx skills add Kevin-Umali/repyy --skill repyy -g -a codex -y

Read the complete agent skill guide →

When coverage is incomplete

Resource limits protect the scanner from hostile repositories and archives. A timeout, unreadable file, denied mount, failed fetch, or exceeded limit is reported as SCAN INCOMPLETE; successful targets remain visible in a mixed scan.

Repository10 minute timeout · 100,000 files · 50 MiB per file

Archive10,000 entries · 1 GiB expanded bytes · 3 nested levels

See coverage limits and exclusions →