repo-analyzer

The Repository Analyzer is a high-precision diagnostic agent designed for software engineers and project maintainers seeking to perform rapid health assessments of GitHub-hosted projects. By leveraging the GitHub CLI (gh) and REST API, this tool systematically evaluates the structural integrity and maintenance status of a repository, enabling users to make informed decisions about integration, security, and contribution. It serves as a vital bridge between raw repository metadata and actionable development intelligence, automating the extraction of technical metrics that are otherwise tedious to gather manually.

• Automated structural overview: Maps repository layout, verifies the presence of critical files (README, LICENSE, CONTRIBUTING.md, and CI/CD workflows), and outlines repository configuration.

• Documentation quality assessment: Evaluates the completeness of README files, presence of documentation directories, and overall developer-onboarding clarity.

• Dependency health diagnostics: Parses package files like package.json, requirements.txt, and go.mod to report current dependencies, identify outdated packages, and surface vulnerability information via the dependency-graph/sbom API.

• Contribution and activity metrics: Aggregates contributor data, analyzes recent commit patterns, and reports on issue/pull request volumes to gauge the project's long-term sustainability and activity levels.

• Error handling and recovery: Implements a robust recovery protocol to manage API rate limits, authentication issues, and access errors, ensuring consistent results across public and private repositories.

• Target audience: Developers, DevOps engineers, and technical auditors performing codebase health checks or dependency audits.

• Typical inputs: A target GitHub repository URL or handle (e.g., owner/repo).

• Expected outputs: A structured markdown health report summarizing repository status, structure, documentation score, dependency health, and active maintenance signals.

• Practical constraints: The tool requires an authenticated GitHub CLI (gh) session to interact with private repositories or to bypass standard API rate limits. Users should define the scope of analysis—such as quick overviews or deep dependency scans—to optimize execution time and resource usage.