README badge

Add a live health score badge to your README

One line of Markdown. The grade is recomputed after every scan and served from the last report.

Every grade, live

Quick start

Paste your GitHub repo URL in the playground for a free preview. The badge shows a grade once a paid scan (from $29) is on record.

Replace owner/repo with your GitHub repo path.

Markdown (README.md)

[![GateTest](https://gatetest.io/badge/owner/repo.svg)](https://gatetest.io/playground)

HTML

<a href="https://gatetest.io/playground"><img src="https://gatetest.io/badge/owner/repo" alt="GateTest"></a>

reStructuredText

.. image:: https://gatetest.io/badge/owner/repo.svg
   :target: https://gatetest.io/playground
   :alt: GateTest

The badge updates automatically after every GateTest scan. No re-configuration needed.

Parameter	Description
repo	GitHub repo in `owner/name` format (required). Shows `not scanned` until a scan is on record.
flake	The last segment. `flake 2.5%` is the share of your tests measured as flaky (they flip between pass and fail) once a run of your test suite has been recorded for the repo. `flake not measured` means no such run is on record — never a 0%.

Endpoint: GET https://gatetest.io/badge/owner/repo.svg

Cache: 5 minutes (max-age=300, public)

Contributors and users see your code quality grade before they read a single line of code.

The badge reflects the latest completed scan. Run a scan → badge updates. No manual steps.

A declining grade is visible to every contributor and every issue reporter.

Ready to earn your badge?