@danieljancar/gh-repo-analyzer NPM

Introduction

This tool is designed to fetch and analyze data from GitHub repositories, part of the M320 module. It provides insights such as commit frequency, contributor count, and language usage.

Usage

Installation

To install the npm tool globally, run the following command:

npm install -g @danieljancar/gh-repo-analyzer

Getting Started

To run the tool, use the following command:

ghra

Options

Option	Description
`-h`, `--help`	Show help
`-V`, `--version`	Show version number

Commands

Command	Description
`detail`	Get detailed information about a repository
`info`	Get information about a repository
`commits`	Get commit information about a repository
`commit`	Get commit information about a repository

Examples

Get detailed information about a repository

ghra detail <owner> <repo>

Get information about a repository

ghra info <owner> <repo>

Get last 5 commits of a repository

ghra commits <owner> <repo>

Get a specific commit of a repository

ghra commit <owner> <repo> <sha>

Development

Prerequisites

Node.js - JavaScript runtime environment
TypeScript - A typed superset of JavaScript
Git - Version control system

Setup

Clone the repository to your local machine.

git clone https://github.com/your-username/github-repo-analyzer.git

Navigate to the project directory.

cd github-repo-analyzer

Install the project dependencies.

npm install

Compile TypeScript to JavaScript.

tsc

Usage

Run the tool from the command line to analyze a GitHub repository.

node dist/main.js

Contributing

I welcome contributions from everyone. Before you get started, please take a moment to review the guidelines.

Branches

This project uses the following branches:

master - The main branch. This branch is used for production releases.
develop - The development branch. This branch is used for development and testing.

Commit Messages

When you commit, make sure to follow the Contributing Guide for commit messages. This will help keep the commit messages clean and consistent across the project. If you don't follow the guide, your pull request will be rejected.

License

This project is licensed under the GNU GPLv3 license. By contributing to this project, you agree that your contributions will be released under the same license. Also, you agree to the Contributor Covenant Code of Conduct and Developer Certificate of Origin.