Skip to content

SenhorH/repo-pulse

Repository files navigation

repo-pulse

A tiny CLI that summarizes repository health at a glance.

repo-pulse scans a local project and prints a compact report covering stack signals, package scripts, docs, CI, language mix, TODO/FIXME markers, and practical next-step signals. It is built for quick triage before publishing, reviewing, or handing off a repo.

Features

  • Scans local repositories without network calls.
  • Detects package metadata, package manager, scripts, and dependency counts.
  • Checks for README, license, changelog, contributing guide, GitHub Actions, and Git.
  • Summarizes languages by file count and byte size.
  • Counts TODO, FIXME, HACK, and XXX markers.
  • Outputs human-readable markdown or machine-readable JSON.
  • Ignores noisy directories such as node_modules, .git, dist, build, and coverage.

Install From Source

git clone https://github.com/SenhorH/repo-pulse.git
cd repo-pulse
npm install
npm run build
npm link

Then run:

repo-pulse /path/to/project

Usage

repo-pulse
repo-pulse ../tab-labeler
repo-pulse --json
repo-pulse --max-files 1000
repo-pulse --help

Example output:

# my-project pulse

## Snapshot

- Files scanned: 42
- Git repository: ok
- Package: my-project@0.1.0
- Scripts: build, lint, test

## Signals

- Add a LICENSE file before inviting external contributors.
- Review 3 TODO/FIXME marker(s) before release.

Development

npm install
npm run lint
npm test
npm run build
node dist/cli.js --max-files 100

Privacy

repo-pulse is local-only.

  • No backend.
  • No telemetry.
  • No analytics.
  • No network requests.
  • No files are uploaded or modified.

Roadmap

  • Add optional git dirty-state and recent-commit summary.
  • Add severity scoring for missing project basics.
  • Add --fail-on checks for CI usage.
  • Add compact terminal colors when stdout is interactive.

About

A tiny CLI that summarizes repository health at a glance.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors