Skip to content

Repository files navigation

npm version CI License: MIT Node

repomark

Score README and OSS repo health from the terminal.
Badges, license, docs, package.json metadata, and CI — one checklist score.

Quick start · What it checks · badgekit


Why repomark?

OSS repos quietly rot: missing license, no security policy, thin README, no badges. repomark gives you a 0–100 score and concrete next steps — no SaaS, no API key.

Quick start

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

Exit code is 1 when the score is below --min (default 70) — useful in CI.

# .github/workflows/repomark.yml
- uses: topdaily-dev/repomark-action@v1
  with:
    min: "70"

What it checks

Area Notes
README Exists, # title, short description
Badges shields.io / CI badge links
License LICENSE file
Contributing CONTRIBUTING.md or section
Security SECURITY.md or section
package.json name, description, license, repository, engines
CI .github/workflows
Issue templates .github/ISSUE_TEMPLATE
Code of conduct CODE_OF_CONDUCT.md
Dependabot .github/dependabot.yml
Node version .nvmrc vs engines.node
Topics Reminder only (needs GitHub UI / API)

Pair with badgekit

Missing badges? Generate a paste-ready row:

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

Recipe: badgekit repomark-check.

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.

CLI

repomark check [dir] [--min N] [--json]
repomark fix [dir] [--dry-run] [--json]

fix writes safe templates for missing LICENSE, SECURITY.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, Dependabot config, .nvmrc, and a starter CI workflow. Use --dry-run to preview.

After repo health passes, ship releases with @topdaily-dev/shipkit.

Development

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

Pair commits use human co-authors only — see CONTRIBUTING.md and collab-kit git-attribution.

License

MIT — see LICENSE.

About

Score README and OSS repo health from the terminal

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages