RepoGuard

Audit the health of any public GitHub repository. Get actionable insights to improve your project's community, security, and maintenance posture.

Quick Start

pip install repoguard
repoguard owner/repo

Or run without installing:

npx repoguard owner/repo   # (coming soon)

What It Checks

Category	Checks
Documentation	README, License, Description, Topics
Community	Code of Conduct, Contributing Guide, Issue/PR Templates
Maintenance	Recent Activity, Stale Issues, Open PRs, Releases
Security	Branch Protection, CI/CD Status
Growth	Stars, Forks, Contributors

Example Output

  RepoGuard — Health Report for tweepy/tweepy
  ============================================================

  PASS License: MIT License
  PASS README found (4289 bytes)
  WARN Description: No repository description
     Tip: Add a description in repo settings.
  PASS Recent Activity: Last push 2 days ago
  WARN Stale Issues: 8/45 issues older than 90 days
     Tip: Consider closing or triaging stale issues.

  ------------------------------------------------------------
  Health Score: 72/100 (72%)
  Verdict: Good — needs attention in some areas

GitHub Action

Add RepoGuard to your CI pipeline:

name: RepoGuard Health Check

on:
  schedule:
    - cron: '0 8 * * 1'  # Every Monday at 8 AM

jobs:
  health-check:
    runs-on: ubuntu-latest
    steps:
      - uses: SyntaxHQDEV/repoguard-action@v1
        with:
          repo: ${{ github.repository }}
          fail-below: 60

CLI Usage

# Basic audit
repoguard owner/repo

# JSON output for programmatic use
repoguard owner/repo --json

# Markdown report
repoguard owner/repo --markdown -o report.md

# Fail CI if score is below threshold
repoguard owner/repo --fail-below 60

# With explicit GitHub token
repoguard owner/repo --token ghp_xxx

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

MIT © SyntaxHQ