napetrov/AgentReady Repository Scanner

Scan a repository for AI coding-agent readiness and gate pull requests on regressions.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pathPath to the repository (or subdirectory) to scan.no.
modescan (full repository) or diff (compare two refs).noscan
base-refBase git ref for diff mode (e.g. origin/main).no""
head-refHead git ref for diff mode (e.g. HEAD).no""
configPath to an AgentReady config file.no""
fail-on-severityFail when a finding at or above this severity is present: off, info, warning, or error.noerror
fail-on-regressionIn diff mode, fail when new error/warning regressions are introduced.nofalse
min-scoreFail when the readiness score is below this value (0-100). Empty disables the gate.no""
policyPolicy pack applying severity adjustments before gating: default (no-op), enterprise (stricter instruction/install/deploy gates), oss (stricter contribution-onboarding gates), or ml-scientific (relaxed large-fixture/lint gates). Raw findings/score are never mutated; see docs/product/policy-packs.md.nodefault
job-summaryWrite the markdown report to the GitHub Actions job summary.notrue
pr-commentPost (and update in place) a sticky pull-request comment with the markdown report. Requires github-token with pull-requests: write and a pull_request-triggered run. Fail-open: commenting problems warn but never fail the action.nofalse
pr-comment-conditionWhen to post the PR comment: on-findings (default — comment only when there are new findings/regressions, staying silent on clean runs but still updating a prior comment to its resolved state) or always (post on every run, including clean ones).noon-findings
github-tokenToken used to post the PR comment (needs pull-requests: write). Defaults to the workflow GITHUB_TOKEN. Only used when pr-comment is enabled.no${{ github.token }}
upload-sarifWrite a SARIF report alongside the JSON/markdown reports.nofalse
output-dirDirectory the report artifacts are written to.no.agentready
tool-versionTool version recorded in the SARIF driver.no""
analyzeRun the optional LLM analytics layer after the deterministic gates. Requires a provider (e.g. GitHub Models via AGENTREADY_USE_GITHUB_MODELS=1 + GITHUB_TOKEN with models: read). Off by default; absent a provider it runs deterministic-only.nofalse
analyze-min-scoreFail when the augmented score is below this value (0-100). Empty disables the augmented-score gate. Only meaningful with analyze enabled.no""
namedescription
scoreReadiness score (0-100). In diff mode, the head score.
findings-countNumber of findings (in diff mode, the number of new findings).
regressions-countNumber of readiness regressions (diff mode only).
json-report-pathPath to the written JSON report.
markdown-report-pathPath to the written markdown report.
sarif-report-pathPath to the written SARIF report, when upload-sarif is enabled.
augmented-scoreThe LLM-augmented score (0-100), when analyze is enabled.
augmented-report-pathPath to the written augmented report, when analyze is enabled.
policy-adjustments-countNumber of findings whose severity the policy pack adjusted (0 for the default policy).
policy-effective-scoreThe policy-adjusted score, when a non-default policy is set. `score` is always the raw, policy-independent value.