Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Build

AppVeyor:/appveyor/ci/:user/:repo
AppVeyor branch:/appveyor/ci/:user/:repo/:branch
AppVeyor tests:/appveyor/tests/:user/:repo
AppVeyor tests (branch):/appveyor/tests/:user/:repo/:branch
AppVeyor tests (compact):/appveyor/tests/:user/:repo?compact_message
AppVeyor tests with custom labels:/appveyor/tests/:user/:repo?failed_label=bad&passed_label=good&skipped_label=n%2Fa
Azure DevOps builds:/azure-devops/build/:organization/:projectId/:definitionId
Azure DevOps builds (branch):/azure-devops/build/:organization/:projectId/:definitionId/:branch
Azure DevOps releases:/azure-devops/release/:organization/:projectId/:definitionId/:environmentId
Azure DevOps tests:/azure-devops/tests/:organization/:project/:definitionId
Azure DevOps tests (branch):/azure-devops/tests/:organization/:project/:definitionId/:branch
Azure DevOps tests (compact):/azure-devops/tests/:organization/:project/:definitionId?compact_message
Azure DevOps tests with custom labels:/azure-devops/tests/:organization/:project/:definitionId?failed_label=bad&passed_label=good&skipped_label=n%2Fa
Bitbucket Pipelines:/bitbucket/pipelines/:user/:repo
Bitbucket Pipelines branch:/bitbucket/pipelines/:user/:repo/:branch
Bitrise:/bitrise/:appId/:branch??token=GCIdEzacE4GW32jLVrZb7A
Buildkite:/buildkite/:identifier
Buildkite (branch):/buildkite/:identifier/:branch
CircleCI:/circleci/build/:vcsType/:user/:repo/:branch*?token=abc123def456
Cirrus CI - Base Branch Build Status:/cirrus/github/:user/:repo?script=test&task=analyze
Cirrus CI - Specific Branch Build Status:/cirrus/github/:user/:repo/:branch?script=test&task=analyze
Cirrus CI - Specific Task Build Status:/cirrus/github/:user/:repo?task=analyze
Cirrus CI - Task and Script Build Status:/cirrus/github/:user/:repo?script=test&task=analyze
Codeship:/codeship/:projectId
Codeship (branch):/codeship/:projectId/:branch
continuousphp:/continuousphp/:provider/:user/:repo
continuousphp:/continuousphp/:provider/:user/:repo/:branch
Docker Automated build:/docker/automated/:user/:repo
Docker Build Status:/docker/build/:user/:repo
Docker Cloud Automated build:/docker/cloud/automated/:user/:repo
Docker Cloud Build Status:/docker/cloud/build/:user/:repo
Drone (cloud):/drone/build/:user/:repo
Drone (cloud) with branch:/drone/build/:user/:repo/:branch
Drone (self-hosted):/drone/build/:user/:repo?server=https%3A%2F%2Fdrone.shields.io
Drone (self-hosted) with branch:/drone/build/:user/:repo/:branch?server=https%3A%2F%2Fdrone.shields.io
GitHub pull request check state:/github/status/s/pulls/:user/:repo/:number
GitHub pull request check contexts:/github/status/contexts/pulls/:user/:repo/:number
Gitlab pipeline status:/gitlab/pipeline/:user/:repo
Gitlab pipeline status (branch):/gitlab/pipeline/:user/:repo/:branch
Gitlab pipeline status (self-hosted):/gitlab/pipeline/:user/:repo?gitlab_url=https%3A%2F%2Fgitlab.gnome.org
Jenkins:/jenkins/build/:protocol/:host/:job+
Jenkins tests:/jenkins/tests/:protocol/:host/:job+?compact_message&failed_label=failed&passed_label=passed&skipped_label=skipped
Read the Docs:/readthedocs/:packageName
Read the Docs (version):/readthedocs/:packageName/:version
Scrutinizer build (GitHub/Bitbucket):/scrutinizer/build/:vcs/:user/:repo/:branch?
Scrutinizer build (GitLab):/scrutinizer/build/gl/:instance/:user/:repo/:branch?
Shippable:/shippable/:projectId
Shippable branch:/shippable/:projectId/:branch
Sonar Tests:/sonar/tests/:component?compact_message&failed_label=failed&passed_label=passed&server=http%3A%2F%2Fsonar.petalslink.com&skipped_label=skipped&sonarVersion=4.2
Sonar Test Count:/sonar/:metric/:component?server=http%3A%2F%2Fsonar.petalslink.com&sonarVersion=4.2
Sonar Test Execution Time:/sonar/test_execution_time/:component?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
Sonar Test Success Rate:/sonar/test_success_density/:component?server=https%3A%2F%2Fsonarcloud.io&sonarVersion=4.2
TeamCity Build Status (CodeBetter):/teamcity/codebetter/:buildId
TeamCity Simple Build Status:/teamcity/:protocol/:hostAndPath/s/:buildId
TeamCity Full Build Status:/teamcity/:protocol/:hostAndPath/e/:buildId
Travis (.org):/travis/:user/:repo
Travis (.org) branch:/travis/:user/:repo/:branch
Travis (.com):/travis/com/:user/:repo
Travis (.com) branch:/travis/com/:user/:repo/:branch
Wercker CI Run:/wercker/ci/:applicationId
Wercker CI Run:/wercker/ci/:applicationId/:branch
Wercker Build:/wercker/build/:userName/:applicationName
Wercker Build branch:/wercker/build/:userName/:applicationName/:branch

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