Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 2.37 KB

visual-tour.md

File metadata and controls

44 lines (24 loc) · 2.37 KB

Visual tour

The gallery visualizes findings, setup checks, and recorded scores from v0.24.0 on local fixtures. The animations condense the CLI results into review cards. Read the score contract.

Shareable project card

AgentConfigScore social preview

The solid-background 1280×640 project card is optimized for GitHub link previews and remains readable when a social platform crops or scales it down.

Catch a regression before merge

Both snapshots score 100, but the instruction-file-removed finding requests review

This compare run checks a byte-identical instruction moved across directories. The baseline policy gates the new finding, so the run returns exit 1 even though the scores match. Reproduce the anonymized fixture.

Set up a repository

Install AgentConfigScore, initialize a repository, and verify the integration

The normal setup path is intentionally small: install from PyPI, run init, then use the read-only doctor command to verify configuration, instructions, baseline detection, and the GitHub workflow.

Make known-risk changes visible over time

Three recorded scores from a local unsafe-shell fixture

The chart shows the stored scores for baseline, risk added, and risk resolved. The reusable score-history workflow can preserve JSON, HTML, and badge artifacts for default-branch commits.

How the pieces fit

Configure once, guard every pull request, and keep evidence

The regression gate answers whether a pull request introduced a detected regression. History shows how the deterministic score changed across reviewed commits. They are separate signals with a shared scanner and policy model.

Regenerate the gallery

Run the renderer in a Python 3.12 environment with Git available. It reads the installed release's CLI results, including the regression exit and selected doctor checks from a disposable Git repository. Font selection depends on the rendering host.

python -m pip install agent-config-score==0.24.0 pillow==12.3.0
python scripts/render_demo_gif.py --all

Commit the renderer and generated assets together so visual changes remain reviewable.