Pixel-perfect   Retina-ready   Fast   Consistent   Hackable   No tracking


Build

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

Your Badge

Static


Using dash "-" separator

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

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

Using query string parameters

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

Colors

brightgreengreenyellowgreenyelloworangeredbluelightgrey
successimportantcriticalinformationalinactive
bluevioletff69b49cf

Endpoint

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

Create badges from your own JSON endpoint.

Dynamic

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

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

https://img.shields.io/badge/dynamic/yaml.svg?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=popout&logo=appveyorpopout
?style=popout-square&logo=appveyorpopout-square
?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, .json, .png and a few others, but use them responsibly.

Like This?

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

StatusMetricsGitHub