Embed Badge
A FlawPilot embed badge is a small, always-current image you drop into your README or site. It shows your latest scan score, so visitors, customers, and contributors can see your site's health without running anything themselves.
A sample badge. Yours shows your own domain, score, and tier.
What an embed badge does
- Live score, always current - the badge reflects your most recent scan. Rescan and it updates on its own: no manual editing, no stale numbers.
- Drops in anywhere - copy a single Markdown or HTML snippet into your README, docs, or landing page. It renders as a clean score badge wherever images are allowed.
- Builds trust at a glance - a visible health score signals that you take security, performance, and SEO seriously, before anyone reads a line of your code.
Before you start
- A FlawPilot account (free to create).
- At least one completed scan of the site you want to badge.
- Somewhere that renders Markdown or HTML images - a README, docs, or your site.
How to add one
1. Run a scan
Scan your site in the dashboard. Your badge is cut from a completed scan, so you need at least one.
2. Grab your snippet
Open the badge tools, pick a live or pinned badge, and copy the ready-made Markdown or HTML.
3. Paste and ship
Drop the snippet into your README or site. The badge stays in sync with every future rescan.
Three ways to add it
Every badge is a hosted SVG that scales cleanly and stays in sync with your latest scan. Pick whichever fits where it's going - all three render the same badge:
Replace YOUR_SITE_ID with your own site ID from the dashboard.
Markdown - for a README
[](https://dev.flawpilot.com/scan/latest?site=YOUR_SITE_ID)
HTML - for your site
<a href="https://dev.flawpilot.com/scan/latest?site=YOUR_SITE_ID">
<img src="https://api.dev.flawpilot.com/v1/badge?site_id=YOUR_SITE_ID&pillar=overall&live=1"
alt="FlawPilot Overall Score: 92/100, Hardened" width="370" height="155" />
</a>
Install it with AI
Paste this into an AI assistant and it will add the badge for you.
I want to add a FlawPilot score badge to my website and GitHub repository.
Live badge (auto-updates):
https://api.dev.flawpilot.com/v1/badge?site_id=YOUR_SITE_ID&pillar=overall&live=1
Report URL: https://dev.flawpilot.com/scan/latest?site=YOUR_SITE_ID
Please help me add this badge in the following places:
1. My GitHub README.md - show me the exact Markdown snippet to paste
2. My website HTML - a clean <a><img> snippet with correct, score-specific alt text
3. My website footer - best placement and styling tips for a score badge
4. Any other relevant places (npm page, documentation, etc.)
The badge is an SVG that scales cleanly to any size.
The score is baked into the alt text in these snippets. If you pin a badge to a fixed scan, update the alt text to match - for a live badge, keep it generic.
Frequently asked questions
What does a FlawPilot embed badge show?
Your site's latest overall health score from FlawPilot, drawn from its most recent scan across security, performance, infrastructure, and SEO.
Does the badge update automatically?
A live badge does - it always reflects your most recent scan, so every time you rescan, the badge updates on its own. You can also pin a badge to a specific scan if you want a fixed result.
Where can I put the badge?
Anywhere that renders an image from Markdown or HTML - a GitHub or GitLab README, your documentation, or your own website.
Do I need an account to add a badge?
Yes. Badges are generated from your own scans, so you'll need a FlawPilot account and at least one completed scan. Creating an account is free.
How do I get my badge snippet?
Open the badge tools in your dashboard, choose a live or pinned badge, and copy the ready-made Markdown or HTML snippet. Paste it wherever you want the badge to appear.