@topdaily-dev/badgekit
v0.2.0
Published
Generate shields.io README badge rows from the terminal
Maintainers
Readme
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/badgekitOutput:
[](https://github.com/topdaily-dev/badgekit/actions/workflows/ci.yml) [](https://www.npmjs.com/package/@topdaily-dev/badgekit) [](LICENSE) [](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/badgekitHEAD-checks image URLs in your README (or generated badge src/href links).
badgekit listExamples
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 htmlGitHub stars badge:
badgekit row stars --owner topdaily-dev --repo badgekitCustom CI workflow file:
badgekit row ci --owner topdaily-dev --repo badgekit --workflow test.ymlInstall
npm install -g @topdaily-dev/badgekitCheck repo health with repomark
After badges, score the rest of your OSS checklist:
npx @topdaily-dev/repomark check .
npx @topdaily-dev/repomark fix . --dry-runSee repomark — README, license, contributing, security, package.json, and CI in one score.
Development
git clone https://github.com/topdaily-dev/badgekit.git
cd badgekit
npm test
node bin/badgekit.mjs --helpSee CONTRIBUTING.md for PR guidelines.
License
MIT — see LICENSE.
