Weave Code
Badger Laravel Package
cachethq/badger
Badger is CachetHQ's badge generator, producing SVG status badges for your Cachet status page components so you can embed live uptime and status indicators in READMEs, dashboards, or docs.
An SVG badge generator for Laravel.
Frequently asked questions about Badger
- What is cachethq/badger used for?
- cachethq/badger is CachetHQ's badge generator for Laravel. It renders shields.io-style SVG status badges for Cachet status page components so you can embed live uptime and status indicators in READMEs, dashboards, or documentation. It is a presentation-layer utility with no persistence or queue dependencies.
- How do I install cachethq/badger in a Laravel application?
- Install it with Composer, then rely on Laravel package auto-discovery. You can optionally publish its config and views if you need to customize rendering. Badges can be rendered from Blade templates or served through a route.
- Which Laravel versions does cachethq/badger support?
- Version 5.0.0 explicitly targets Laravel 12 and 13. The release notes direct Laravel 8 through 10 users to the 4.x branch. Laravel 11 is not listed in the stated support matrix, so treat it as unverified rather than supported.
- Can I use cachethq/badger with Laravel 11?
- There is no stated position for Laravel 11 in the v5 release notes; it sits in the gap between the 8–10 guidance and the 12/13 support claim. It may work under the same constraints, but likely works is not a support claim. Run a spike before treating it as a drop-in, or pin the 4.x line if you need a known-supported version.
- What PHP version does cachethq/badger v5 require?
- Version 5 requires PHP 8.2 or newer as a hard runtime constraint. Services still on PHP 8.1 cannot take v5 and must stay on the 4.x branch. The package's PHP 8.4 compatibility, including explicit nullable parameters, is a positive if you plan to move to 8.4 during this cycle.
- How do I upgrade cachethq/badger from 3.x to 5.x?
- Do not jump blindly. Confirm your runtime is PHP 8.2+ and your framework is Laravel 12 or 13, then read the 4.0 changelog and upgrade guide before bumping to 5.x on a branch. Re-publish config and views, diff them against your current published copies, and visually diff rendered badge output. If the 4.x changelog is unavailable or unclear, upgrade to 4.x first, validate, then move to 5.x.
- Does cachethq/badger replace shields.io?
- Yes, for Cachet status page badges. Badger renders the SVG locally instead of making image-generation calls to shields.io, which removes a third-party runtime dependency from status pages, READMEs, and dashboards. The tradeoff is that you own the rendering and its output contract.
- Can cachethq/badger badges be cached behind a CDN?
- The package is a presentation-layer renderer with no persistence or per-request state, so output is generally deterministic and suitable for caching. Confirm this against your own implementation and route setup before putting badges behind a CDN. Also remember that a style change, such as the new for-the-badge style, changes the SVG output.
- How should I test cachethq/badger badge output?
- Treat the SVG output as a contract if you rely on it visually. Use snapshot or visual regression tests so unintended rendering changes are caught. Be aware that cosmetic changes such as the for-the-badge style are test-breaking changes if your assertions compare exact markup. You can also visually diff badges before and after upgrades.
- Is cachethq/badger production-ready and what maintenance risks should I know?
- Overall technical risk is low: it is a small, single-purpose presentation-layer package with no persistence, queues, or external service dependency. The main caveats are the PHP 8.2+ floor, the unstated Laravel 11 position, and the changelog that skips v4.0.0, leaving breaking changes from that major not enumerated. The automated release pipeline improves traceability, but it does not by itself prove maintainer depth, so record the bus factor and release cadence in your review.
Weaver
How can I help you explore Laravel packages today?