A live vulnerability badge for your README

Show that your project has no known vulnerable dependencies, or that you know about the ones it has. The badge is updated after every daily check from OSV.dev. Free with an AIssue account.

AIssue: 0 known vulnerabilitiesAIssue: 2 highAIssue: 1 criticalAIssue: 3 mediumAIssue: not scanned yet

Add it in two minutes

  1. Create a free AIssue account and add your repository: connect GitHub, or paste its lockfile.
  2. Wait for the first check: it takes a minute. AIssue checks every exact package version in your lockfiles against OSV.dev.
  3. Turn on the README badge in the repository's card on the Security page, and pick a style.
  4. Copy the snippet (Markdown, HTML or reStructuredText) into your README.

How the count works

The badge counts the known vulnerabilities AIssue currently has open for the repository: every package version in its lockfiles, direct and transitive, checked against OSV.dev. It shows the highest severity with its count ("2 high"), or "0 known vulnerabilities". Alerts you ignore in AIssue (for example a vulnerability in a feature you don't use) are not counted, and fixed ones drop off at the next check.

AIssue re-checks every monitored repository daily and whenever its default branch changes. GitHub caches README images, so the badge can take up to an hour to change there. It says "known" on purpose: no tool can prove a project has no vulnerabilities.

Using shields.io instead

Each badge also has a JSON address in the shields.io endpoint format. Point https://img.shields.io/endpoint?url=… at it to draw the badge in any shields.io style.

Private repositories

The badge address uses a random token, never the repository's name, and shows only a count and a severity, never package names. Anyone who has the address can still see that count, so AIssue asks you to confirm before turning on a badge for a private repository. Turning it off makes the address show "badge off" at once.

Questions

How often does the badge update?

AIssue checks monitored repositories every day and when their default branch changes; the badge follows within minutes. GitHub caches README images, so allow up to an hour for it to show there.

Does the badge reveal my private repository?

No name appears: the badge address uses a random token. It shows only counts and severity, never package names. Anyone with the address can see that count, so AIssue asks you to confirm before turning it on for a private repository.

Why does the badge show a vulnerability GitHub doesn't?

AIssue uses OSV.dev, which brings together several advisory databases (GitHub's included) and checks the exact versions in your lockfiles, transitive dependencies included. Open the repository in AIssue to see each advisory and its fix.

Can I use it with shields.io?

Yes: every badge also has a JSON address in the shields.io "endpoint" format, so you can draw it with any shields.io style.

Can I remove it?

Yes. Turning the badge off makes its address show "badge off" right away; turning it on again gives a new address.

Last updated .