{"id":13895116,"url":"https://github.com/sourcegraph/buckler","last_synced_at":"2025-07-17T10:32:41.378Z","repository":{"id":57591734,"uuid":"12456122","full_name":"sourcegraph/buckler","owner":"sourcegraph","description":"Programmatic Status Shields/Badges","archived":false,"fork":true,"pushed_at":"2015-01-26T22:19:48.000Z","size":2439,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-07T18:32:40.895Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://buckler.repl.ca","language":"Go","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"badges/buckler","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourcegraph.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-29T09:11:30.000Z","updated_at":"2024-07-25T16:45:36.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sourcegraph/buckler","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fbuckler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fbuckler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fbuckler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcegraph%2Fbuckler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourcegraph","download_url":"https://codeload.github.com/sourcegraph/buckler/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226255334,"owners_count":17595859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-06T18:02:00.656Z","updated_at":"2024-11-25T00:30:54.126Z","avatar_url":"https://github.com/sourcegraph.png","language":"Go","readme":"# ⛨ Buckler ⛨\n\n[![Build Status](https://travis-ci.org/gittip/img.shields.io.png)](https://travis-ci.org/gittip/img.shields.io)\n[![Buckler Shield](http://b.repl.ca/v1/use-buckler-blue.png)](http://buckler.repl.ca)\n[![Get Hype](http://b.repl.ca/v1/GET-HYPE!-orange.png)](http://buckler.repl.ca)\n[![MIT License](http://b.repl.ca/v1/License-MIT-red.png)](LICENSE)\n[![CLI interface](http://b.repl.ca/v1/command-line-blue.png)](#command-line)\n\nBuckler is [Shields](https://github.com/olivierlacan/shields) as a Service (ShaaS, or alternatively, Badges as a Service)\nfor use in GitHub READMEs, or anywhere else. Use buckler with your favorite continuous integration tool, performance\nmonitoring service API, or ridiculous in-joke to surface information.\n\nBuckler is available hosted at [b.repl.ca](http://buckler.repl.ca). You may use the [API](#API) to generate shields at runtime,\npregenerate them and host them on your own service, or run your own copy of Buckler to protect important company secrets.\n\n# API\n\nBuckler tries to make creating shields easy. Each shield request is a url that has three parts:\n- `subject`\n- `status`\n- `colour`\n\nParts are separated by a hyphen. The request is suffixed by `.png` and prefixed with the Buckler host and API version, likely\n`b.repl.ca/v1/`. Requests will take the form: `http://b.repl.ca/v1/$SUBJECT-$STATUS-$COLOR.png`\n\n## Examples\n\n- http://b.repl.ca/v1/build-passing-brightgreen.png ⇨ ![](http://b.repl.ca/v1/build-passing-brightgreen.png)\n- http://b.repl.ca/v1/downloads-3.4K-blue.png ⇨ ![](http://b.repl.ca/v1/downloads-3.4K-blue.png)\n- http://b.repl.ca/v1/coverage-unknown-lightgrey.png ⇨ ![](http://b.repl.ca/v1/coverage-unknown-lightgrey.png)\n- http://b.repl.ca/v1/review-NACKED-red.png ⇨ ![](http://b.repl.ca/v1/review-NACKED-red.png)\n- http://b.repl.ca/v1/enterprise-ready-ff69b4.png ⇨ ![](http://b.repl.ca/v1/enterprise-ready-ff69b4.png)\n\n## Valid Colours\n\n- `brightgreen` ⇨ ![](http://b.repl.ca/v1/colour-brightgreen-brightgreen.png)\n- `green` ⇨ ![](http://b.repl.ca/v1/colour-green-green.png)\n- `yellowgreen` ⇨ ![](http://b.repl.ca/v1/colour-yellowgreen-yellowgreen.png)\n- `yellow` ⇨ ![](http://b.repl.ca/v1/colour-yellow-yellow.png)\n- `orange` ⇨ ![](http://b.repl.ca/v1/colour-orange-orange.png)\n- `red` ⇨ ![](http://b.repl.ca/v1/colour-red-red.png)\n- `grey` ⇨ ![](http://b.repl.ca/v1/colour-grey-grey.png)\n- `lightgrey` ⇨ ![](http://b.repl.ca/v1/colour-lightgrey-lightgrey.png)\n- `blue` ⇨ ![](http://b.repl.ca/v1/colour-blue-blue.png)\n\nSix digit RGB hexidecimal colour values work as well:\n\n- `804000` - ![](http://b.repl.ca/v1/colour-brown-804000.png)\n\n### Grey?\n\nDon't worry; `gray` and `lightgray` work too.\n\n## Escaping Underscores and Hyphens\n\nHyphens (`-`) are used to delimit individual fields in your shield request. To include a literal hyphen, use two hyphens (`--`):\n\nhttp://b.repl.ca/v1/really--cool-status-yellow.png ⇨ ![](http://b.repl.ca/v1/really--cool-status-yellow.png)\n\nSimilarly, underscores (`_`) are used to indicated spaces. To include a literal underscore, use two underscores (`__`):\n\nhttp://b.repl.ca/v1/__private-method_name-lightgrey.png ⇨ ![](http://b.repl.ca/v1/__private-method_name-lightgrey.png)\n\n## URL Safe\n\nBuckler API requests are just HTTP GETs, so remember to URL encode!\n\nhttp://b.repl.ca/v1/uptime-99.99%25-yellowgreen.png ⇨ ![](http://b.repl.ca/v1/uptime-99.99%25-yellowgreen.png)\n\n# Try It Out\n\nPlay around with the simple form on [b.repl.ca](http://b.repl.ca)\n\n# Installing\n\n```bash\ngo get github.com/gittip/img.shields.io\n```\n\nAlternatively, `git clone` and `go build` to run from source.\n\n# Command Line\n\nBuckler also provides a command line interface:\n\n```bash\n# writes to build-passing-brightgreen.png\nbuckler -v build -s passing -c brightgreen\n\n# writes to my-custom-filename.png\nbuckler -v build -s passing -c green my-custom-filename.png\n\n# writes to standard out\nbuckler -v license -s MIT -c blue -\n\n# writes 2 shields\nbuckler build-passing-brightgreen.png license-MIT-blue.png\n```\n\n# Thanks\n\n- Olivier Lacan for the [shields](https://github.com/olivierlacan/shields) repo\n- Steve Matteson for [Open Sans](http://opensans.com/)\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcegraph%2Fbuckler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourcegraph%2Fbuckler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcegraph%2Fbuckler/lists"}