Skip to content

klim badge

klim badge prints Shields.io-compatible badge markdown that summarises your current klim state. Drop the output into a project README, a personal profile, a team dashboard, or a CI status page to show off (or alert on) your toolchain health.

Terminal window
klim badge [flags]
BadgeWhat it shows
klim scoreOverall environment score X/Y graded A+..F (matches klim score --badge).
klim toolsNumber of installed tools.
klim auditAudit-findings count (clean or N issues). Counts klim audit warnings + infos — not vulnerability scan results; for CVEs use klim security.
klim freshPercentage of installed tools currently up to date.

By default every badge is printed. Use the per-badge flags to pick a subset.

FlagDescription
--allPrint every badge (the no-flag default).
--scoreInclude the score badge.
--toolsInclude the tools badge.
--auditInclude the audit badge.
--freshInclude the fresh-percent badge.
--refreshIgnore the scan cache and rescan.
--outputtext (default, Markdown), json, or yaml.
Terminal window
# Every badge, ready to paste into a README
klim badge
# Just score + audit
klim badge --score --audit
# Score badge URL only — same colour table as `klim score --badge`
klim badge --score | head -1
# Machine-readable
klim badge --output json
klim badge --output yaml > badges.yaml

Text output is Markdown — one badge per line:

[![klim score](https://img.shields.io/badge/klim%20score-61%2F100%20D-orange)](https://github.com/nassiharel/klim)
[![klim tools](https://img.shields.io/badge/klim%20tools-23-blue)](https://github.com/nassiharel/klim)
[![klim audit](https://img.shields.io/badge/klim%20audit-clean-brightgreen)](https://github.com/nassiharel/klim)
[![klim fresh](https://img.shields.io/badge/klim%20fresh-87%25-green)](https://github.com/nassiharel/klim)

The score badge’s colour comes from internal/score.BadgeColor, the same helper klim score --badge uses, so the two commands always agree on the colour for the same score.

klim badge only runs the doctor + compliance + audit pipeline when the badges you asked for need it. klim badge --tools --fresh skips that work entirely; klim badge --output yaml includes the full structured score block so it always runs the full pipeline.