badgekit

Generate shields.io README badge rows from the terminal.

Quick start · Badges · Examples

---

Why badgekit?

README badges are repetitive copy-paste. badgekit prints ready-to-paste markdown or HTML badge rows for common shields — CI, npm, license, Node, releases, downloads, and stars.

No config files. No framework. Plain terminal output you own.

Quick start

npx @topdaily-dev/badgekit row ci npm license node \
  --owner topdaily-dev \
  --repo badgekit \
  --npm @topdaily-dev/badgekit

Output:

[![CI](https://github.com/topdaily-dev/badgekit/actions/workflows/ci.yml/badge.svg)](https://github.com/topdaily-dev/badgekit/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/@topdaily-dev/badgekit.svg)](https://www.npmjs.com/package/@topdaily-dev/badgekit) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](package.json)

Badges

ID	Requires
ci	--owner, --repo, optional --workflow
npm	--npm
license	optional --license (default MIT)
node	optional --node (default >=20)
release	--owner, --repo
downloads	--npm
stars	--owner, --repo
codecov	--owner, --repo
bundle-size	--npm
openssf	--owner, --repo

Validate badge URLs

badgekit validate .
badgekit validate row ci npm --owner topdaily-dev --repo badgekit --npm @topdaily-dev/badgekit

HEAD-checks image URLs in your README (or generated badge src/href links).

badgekit list

Examples

See examples/basic.md, examples/npm-project.md, and examples/github-only.md, and examples/html-readme.md.

HTML output for centered README rows:

  badgekit row ci npm license --owner topdaily-dev --repo badgekit --npm @topdaily-dev/badgekit --format html

GitHub stars badge:

badgekit row stars --owner topdaily-dev --repo badgekit

Custom CI workflow file:

badgekit row ci --owner topdaily-dev --repo badgekit --workflow test.yml

Install

npm install -g @topdaily-dev/badgekit

Check repo health with repomark

After badges, score the rest of your OSS checklist:

npx @topdaily-dev/repomark check .
npx @topdaily-dev/repomark fix . --dry-run

See repomark — README, license, contributing, security, package.json, and CI in one score.

Bootstrap with collab-kit

Scaffold team workflows plus this toolchain in one command:

npx @korykaai/collab-kit init . --oss-toolchain
collab-kit enable-hooks .

See collab-kit oss-toolchain.

Development

git clone https://github.com/topdaily-dev/badgekit.git
cd badgekit
npm test
node bin/badgekit.mjs --help

See CONTRIBUTING.md for PR guidelines.

License

MIT — see LICENSE.