Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking

Analysis

Ansible Quality Score:Ansible Quality Score badge/ansible/quality/:projectId
CII Best Practices Level:CII Best Practices Level badge/cii/level/:projectId
CII Best Practices Tiered Percentage:CII Best Practices Tiered Percentage badge/cii/percentage/:projectId
CII Best Practices Summary:CII Best Practices Summary badge/cii/summary/:projectId
ClearlyDefined Score:ClearlyDefined Score badge/clearlydefined/score/:type/:provider/:namespace/:name/:revision
Cocoapods doc percentage:Cocoapods doc percentage badge/cocoapods/metrics/doc-percent/:spec
Codacy grade:Codacy grade badge/codacy/grade/:projectId
Codacy branch grade:Codacy branch grade badge/codacy/grade/:projectId/:branch
Code Climate maintainability:Code Climate maintainability badge/codeclimate/:format/:user/:repo
Code Climate issues:Code Climate issues badge/codeclimate/issues/:user/:repo
Code Climate technical debt:Code Climate technical debt badge/codeclimate/tech-debt/:user/:repo
CodeFactor Grade:CodeFactor Grade badge/codefactor/grade/:vcsType/:user/:repo/:branch*
Coverity Scan:Coverity Scan badge/coverity/scan/:projectId
GitHub language count:GitHub language count badge/github/languages/count/:user/:repo
GitHub search hit counter:GitHub search hit counter badge/github/search/:user/:repo/:query
GitHub top language:GitHub top language badge/github/languages/top/:user/:repo
GitLab language count:GitLab language count badge/gitlab/languages/count/:project+?gitlab_url=https%3A%2F%2Fgitlab.com
npms.io (final):npms.io (final) badge/npms-io/:type/:scope?/:packageName
npms.io (popularity):npms.io (popularity) badge/npms-io/:type/:scope/:packageName
npms.io (quality):npms.io (quality) badge/npms-io/:type/:scope?/:packageName
npms.io (maintenance):npms.io (maintenance) badge/npms-io/:type/:scope?/:packageName
OSSF-Scorecard Score:OSSF-Scorecard Score badge/ossf-scorecard/:host/:orgName/:repoName
Scrutinizer code quality (GitHub/Bitbucket):Scrutinizer code quality (GitHub/Bitbucket) badge/scrutinizer/quality/:vcs/:user/:repo/:branch?
Scrutinizer coverage (GitLab):Scrutinizer coverage (GitLab) badge/scrutinizer/quality/gl/:instance/:user/:repo/:branch?
Snyk Vulnerabilities for GitHub Repo:Snyk Vulnerabilities for GitHub Repo badge/snyk/vulnerabilities/github/:user/:repo
Snyk Vulnerabilities for GitHub Repo (Specific Manifest):Snyk Vulnerabilities for GitHub Repo (Specific Manifest) badge/snyk/vulnerabilities/github/:user/:repo/:manifestFilePath
Snyk Vulnerabilities for npm package:Snyk Vulnerabilities for npm package badge/snyk/vulnerabilities/npm/:packageName
Snyk Vulnerabilities for npm package version:Snyk Vulnerabilities for npm package version badge/snyk/vulnerabilities/npm/:packageName
Snyk Vulnerabilities for npm scoped package:Snyk Vulnerabilities for npm scoped package badge/snyk/vulnerabilities/npm/:packageName
Sonar Documented API Density:Sonar Documented API Density badge/sonar/public_documented_api_density/:component/:branch*?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Fortify Security Rating:Sonar Fortify Security Rating badge/sonar/fortify-security-rating/:component/:branch*?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Quality Gate:Sonar Quality Gate badge/sonar/:metric/:component/:branch*?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Tech Debt:Sonar Tech Debt badge/sonar/:metric/:component/:branch*?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Violations (short format):Sonar Violations (short format) badge/sonar/:metric/:component/:branch*?format=short&server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Violations (long format):Sonar Violations (long format) badge/sonar/:metric/:component/:branch*?format=long&server=http%3A%2F%2Fsonar.petalslink.com
SourceForge languages:SourceForge languages badge/sourceforge/languages/:project
SymfonyInsight Grade:SymfonyInsight Grade badge/symfony/i/grade/:projectUuid
SymfonyInsight Stars:SymfonyInsight Stars badge/symfony/i/stars/:projectUuid
SymfonyInsight Violations:SymfonyInsight Violations badge/symfony/i/violations/:projectUuid
W3C Validation:W3C Validation badge/w3c-validation/:parser?preset=HTML%2C%20SVG%201.1%2C%20MathML%203.0&targetUrl=https%3A%2F%2Fvalidator.nu%2F

Your Badge

Static


Using dash "-" separator

/badge/<LABEL>-<MESSAGE>-<COLOR>

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

Using query string parameters

/static/v1?label=<LABEL>&message=<MESSAGE>&color=<COLOR>

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

/endpoint?url=<URL>&style<STYLE>

Create badges from your own JSON endpoint.

Dynamic

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

/badge/dynamic/xml?url=<URL>&label=<LABEL>&query=<//data/subdata>&color=<COLOR>&prefix=<PREFIX>&suffix=<SUFFIX>

/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, gitlab, npm, paypal, serverfault, stackexchange, superuser, telegram, travis) or simple-icons. All simple-icons are referenced using icon slugs. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository.
?logo=data:image/png;base64,…Insert custom logo image (≥ 14px high). There is a limit on the total size of request headers we can accept (8192 bytes). From a practical perspective, this means the base64-encoded image text is limited to somewhere slightly under 8192 bytes depending on the rest of the request header.
?logoColor=violetSet the color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for named logos and Shields logos but not for custom logos. For multicolor Shields logos, the corresponding named logo will be used and colored.
?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. Note that this only works when integrating your badge in an<object> HTML tag, but not an<img> tag or a markup language.
?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 .png for 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 of https://img.shields.io/npm/v/express is https://raster.shields.io/npm/v/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!

CommunityStatusMetricsGitHub