// badge

Show your security score in your README

Run one scan, copy one line. The badge tells visitors your code was checked for the mistakes AI-generated code makes most often, and links here so they can check theirs. No account, nothing uploaded: the score in the badge is the one the scanner printed on your machine.

What it looks like

Security score 96 of 100Security score 78 of 100Security score 61 of 100Security score 42 of 100Scanned by sixthwall

Add it in three steps

  1. Scan your project. The last line of the output is your score.
    npx @sixthwall/cli init
  2. Put the score in the badge URL and paste the Markdown into your README. Replace 87 with yours.
    README.md
    [![Security score](https://sixthwall.dev/api/badge?score=87)](https://sixthwall.dev/badge)

    Or as HTML:

    HTML
    <a href="https://sixthwall.dev/badge"><img src="https://sixthwall.dev/api/badge?score=87" alt="Security score" /></a>
  3. Update the number when it changes. The scanner prints the exact line to paste after every full scan, so a copy-paste keeps it current.

Prefer not to publish a number?

Leave the score out and the badge just says the project is scanned:

README.md
[![Security score](https://sixthwall.dev/api/badge)](https://sixthwall.dev/badge)

Honest limits

The badge is a statement by the project, not a certificate from us: anyone can put any number in the URL. A verified badge, updated automatically after every pull request scan, is part of the Pro tier in development. Until then, treat it the way you treat a test-coverage badge: a signal that someone cared enough to check.