⛨ Buckler ⛨
Buckler is Shields as a Service (ShaaS, or alternatively, Badges as a Service) for use in GitHub READMEs, or anywhere else. Use buckler with your favorite continuous integration tool, performance monitoring service API, or ridiculous in-joke to surface information.
Buckler is available hosted at b.repl.ca. You may use the API to generate shields at runtime, pregenerate them and host them on your own service, or run your own copy of Buckler to protect important company secrets.
Buckler tries to make creating shields easy. Each shield request is a url that has three parts:
Parts are separated by a hyphen. The request is suffixed by
.png and prefixed with the Buckler host and API version, likely
b.repl.ca/v1/. Requests will take the form:
- http://b.repl.ca/v1/build-passing-brightgreen.png ⇨
- http://b.repl.ca/v1/downloads-3.4K-blue.png ⇨
- http://b.repl.ca/v1/coverage-unknown-lightgrey.png ⇨
- http://b.repl.ca/v1/review-NACKED-red.png ⇨
- http://b.repl.ca/v1/enterprise-ready-ff69b4.png ⇨
Six digit RGB hexidecimal colour values work as well:
lightgray work too.
Escaping Underscores and Hyphens
-) are used to delimit individual fields in your shield request. To include a literal hyphen, use two hyphens (
Similarly, underscores (
_) are used to indicated spaces. To include a literal underscore, use two underscores (
Buckler API requests are just HTTP GETs, so remember to URL encode!
Try It Out
Play around with the simple form on b.repl.ca
go get github.com/badges/buckler
git clone and
go build to run from source.
Buckler also provides a command line interface:
# writes to build-passing-brightgreen.png buckler -v build -s passing -c brightgreen # writes to my-custom-filename.png buckler -v build -s passing -c green my-custom-filename.png # writes to standard out buckler -v license -s MIT -c blue - # writes 2 shields buckler build-passing-brightgreen.png license-MIT-blue.png