Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Analysis

Ansible Quality Score:/ansible/quality/:projectId
CII Best Practices Level:/cii/level/:projectId
CII Best Practices Tiered Percentage:/cii/percentage/:projectId
CII Best Practices Summary:/cii/summary/:projectId
Cocoapods doc percentage:/cocoapods/metrics/doc-percent/:spec
Codacy grade:/codacy/grade/:projectId
Codacy branch grade:/codacy/grade/:projectId/:branch
Code Climate maintainability:/codeclimate/:format/:user/:repo
Code Climate issues:/codeclimate/issues/:user/:repo
Code Climate technical debt:/codeclimate/tech-debt/:user/:repo
CodeFactor Grade:/codefactor/grade/:vcsType/:user/:repo/:branch*
Coverity Scan:/coverity/scan/:projectId
Dependabot SemVer Compatibility:/dependabot/semver/:packageManager/:dependencyName
GitHub language count:/github/languages/count/:user/:repo
GitHub search hit counter:/github/search/:user/:repo/:query
GitHub top language:/github/languages/top/:user/:repo
LGTM Alerts:/lgtm/alerts/:host/:user/:repo
LGTM Grade:/lgtm/grade/:language/:host/:user/:repo
Scrutinizer code quality (GitHub/Bitbucket):/scrutinizer/quality/:vcs/:user/:repo/:branch?
Scrutinizer coverage (GitLab):/scrutinizer/quality/gl/:instance/:user/:repo/:branch?
Snyk Vulnerabilities for GitHub Repo:/snyk/vulnerabilities/github/:user/:repo
Snyk Vulnerabilities for GitHub Repo (Specific Manifest):/snyk/vulnerabilities/github/:user/:repo/:manifestFilePath
Snyk Vulnerabilities for npm package:/snyk/vulnerabilities/npm/:packageName
Snyk Vulnerabilities for npm package version:/snyk/vulnerabilities/npm/:packageName
Snyk Vulnerabilities for npm scoped package:/snyk/vulnerabilities/npm/:packageName
Sonar Documented API Density:/sonar/public_documented_api_density/:component?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Fortify Security Rating:/sonar/fortify-security-rating/:component?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Quality Gate:/sonar/:metric/:component?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Tech Debt:/sonar/:metric/:component?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Violations (short format):/sonar/:metric/:component?format=short&server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Violations (long format):/sonar/:metric/:component?format=long&server=http%3A%2F%2Fsonar.petalslink.com
SymfonyInsight Grade:/symfony/i/grade/:projectUuid
SymfonyInsight Stars:/symfony/i/stars/:projectUuid
SymfonyInsight Violations:/symfony/i/violations/:projectUuid

Your Badge

Static


Using dash "-" separator

https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>

Dashes --- Dash
Underscores ___ Underscore
_ or Space    Space

Using query string parameters

https://img.shields.io/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

https://img.shields.io/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

https://img.shields.io/badge/dynamic/json?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

https://img.shields.io/badge/dynamic/yaml?url=<URL>&label=<LABEL>&query=<$.DATA.SUBDATA>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>


Styles

The following styles are available. Flat is the default. Examples are shown with an optional logo:

?style=plastic&logo=appveyorplastic
?style=flat&logo=appveyorflat
?style=flat-square&logo=appveyorflat-square
?style=for-the-badge&logo=appveyorfor-the-badge
?style=social&logo=appveyorsocial

Here are a few other parameters you can use: (connecting several with "&" is possible)

?label=healthinessesOverride the default left-hand-side text (URL-Encoding needed for spaces or special characters!)
?logo=appveyorInsert one of the named logos from (bitcoin, dependabot, discord, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. Simple-icons are referenced using names as they appear on the simple-icons site. If the name includes spaces, replace them with dashes (e.g: ?logo=visual-studio-code)
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high)
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported)
?logoWidth=40Set the horizontal space to give to the logo
?link=http://left&link=http://rightSpecify what clicking on the left/right of a badge should do (esp. for social badge style)
?labelColor=abcdefSet background of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorA" is also supported.
?color=fedcbaSet background of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported). The legacy name "colorB" is also supported.
?cacheSeconds=3600Set the HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored). The legacy name "maxAge" is also supported.

We support .svg and .json. The default is.svg, which can be omitted from the URL.

While we highly recommend using SVG, we also support .pngfor use cases where SVG will not work. These requests should be made to our raster server https://raster.shields.io. For example, the raster equivalent ofhttps://img.shields.io/v/npm/express ishttps://raster.shields.io/v/npm/express. For backward compatibility, the badge server will redirect .png badges to the raster server.

Like This?

Have an idea for an awesome new badge?
Tell us about it and we might bring it to you!

StatusMetricsGitHub