Skip to main content

Predict why a repository will fail on your machine before you run it.

Project description

repofail logo

repofail

Deterministic runtime compatibility analyzer

Predict why a repository will fail on your machine before you run it.

repofail answers one question: Will this repository actually run here?
It inspects both the repo and your machine — then reports deterministic incompatibilities before you install anything.

Why · Example · Works on · Install · Usage · Rules · CI · Contracts


Why This Exists

Most tools install dependencies.

Few tools tell you:

  • Your Node version violates engines.node.
  • Docker targets the wrong architecture.
  • CUDA is hard-coded with no fallback.
  • CI and local Python versions drifted.

repofail inspects both the repository and your machine — then reports deterministic incompatibilities before install or runtime.


Works on

repofail works on:

  • Python projects
  • Node projects
  • Dockerized repos
  • ML repositories
  • Monorepos

Run it against any local clone.


Example output

repofail output

repofail surfaces deterministic failures before install or runtime. No heuristics. No AI guesses. Evidence only.


Install

From PyPI (recommended)

pip install repofail

Or with pipx (isolated CLI install):

pipx install repofail

From source (development)

git clone https://github.com/jayvenn21/repofail.git
cd repofail
pip install -e .

Usage

# Scan
repofail                    # Scan current dir
repofail -p /path/to/repo   # Scan specific repo
repofail -j                 # JSON output (machine-readable)
repofail -m                 # Markdown output
repofail -v                 # Verbose: rule IDs and low-confidence hints
repofail --ci               # CI mode: exit 1 if HIGH rules fire
repofail --fail-on MEDIUM   # CI: fail on MEDIUM or higher (default: HIGH)
repofail -r                 # Save failure report when rules fire (opt-in telemetry)

# Rules
repofail -e list            # List all rules
repofail -e spec_drift      # Explain a rule

# Contracts
repofail gen .              # Generate env contract to stdout
repofail gen . -o contract.json
repofail check contract.json

# Fleet
repofail a /path            # Audit: scan all repos in directory
repofail a /path -j         # Audit with JSON output
repofail sim . -H host.json # Simulate: would this work on target host?
repofail s                  # Stats: local failure counts (from -r reports)
repofail s -j               # Stats with JSON output

CI integration

- uses: actions/checkout@v4
- uses: actions/setup-python@v5
  with:
    python-version: "3.12"
- run: pip install repofail
- run: repofail --ci

Exits 1 if HIGH rules fire. Use --fail-on MEDIUM to be stricter.

Contracts

repofail gen . -o contract.json
repofail check contract.json

Versioned runtime expectations. Teams share contracts. CI checks drift.


Rules

Tool Reads Repo Inspects Host Predicts Failure CI Enforceable
pip
Docker
repofail

Deterministic rule coverage — repofail includes checks across:

  • Spec violations — version ranges, engines.node, requires-python
  • Architecture mismatches — Apple Silicon vs amd64 Docker
  • Hardware constraints — CUDA requirements, GPU memory
  • Toolchain gaps — missing compilers, Rust, node-gyp
  • Runtime drift — CI vs Docker vs local inconsistencies
  • Environment shape — multi-service RAM pressure, port collisions

See all rules: repofail -e list · Explain one: repofail -e <rule_id>

Rule reference
Rule Severity When
Torch CUDA mismatch HIGH Hard-coded CUDA, host has no GPU
Python version violation HIGH Host outside requires-python range
Spec drift HIGH pyproject vs Docker vs CI — inconsistent Python
Node engine mismatch HIGH package.json engines.node vs host
Lock file missing HIGH package.json has deps, no lock file
Apple Silicon wheel mismatch MEDIUM/HIGH arm64 + x86-only packages or Docker amd64
repofail -e list
Scoring model

Compatibility Score = 100 − Σ(weight × confidence × determinism)

Severity Weight Determinism
HIGH 45 1.0 for spec violations
MEDIUM 20 0.8–1.0
LOW 7 0.5–1.0
INFO 5 structural only

Determinism scale: 1.0 = guaranteed failure · 0.75 = high likelihood · 0.6 = probabilistic (spec drift) · 0.5 = structural risk

Score floors at 10%. When score ≤15% with HIGH rules: "— fatal deterministic violations present".


Architecture

repofail/
  cli.py
  engine.py
  scanner/         # Repo + host inspection
  rules/           # Deterministic rule implementations
  fleet.py         # Audit, simulate

Extensible via .repofail/rules.yaml.


Testing

pytest tests/ -v

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repofail-0.2.1.tar.gz (7.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repofail-0.2.1-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

Details for the file repofail-0.2.1.tar.gz.

File metadata

  • Download URL: repofail-0.2.1.tar.gz
  • Upload date:
  • Size: 7.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for repofail-0.2.1.tar.gz
Algorithm Hash digest
SHA256 fe66a0b350e0ad8dc33fe8d27337b1f76175083f6300d62907ef4c138e335fc2
MD5 6464cd3102e4ba10e33d85fe646af21a
BLAKE2b-256 101f505f99911f9a6911bdbac31724fa8bbfddccac2c2b24a8a1c9db2cd27803

See more details on using hashes here.

Provenance

The following attestation bundles were made for repofail-0.2.1.tar.gz:

Publisher: publish.yml on jayvenn21/repofail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file repofail-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: repofail-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 54.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for repofail-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1fcb48e2b13a0a4bca1faaf690d20a421a37d5251eadd781bb29baeef377e66b
MD5 72d7cdcbbcafe3f369717c5c515bc902
BLAKE2b-256 d43ebc1debf47bcaba21517513333e989f1a7b8a2b2edb8a2b513a31192f4cc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for repofail-0.2.1-py3-none-any.whl:

Publisher: publish.yml on jayvenn21/repofail

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page