Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eziodevio/gh-repo-stats

A GitHub CLI extension that fetches and displays statistics for any GitHub repository.
https://github.com/eziodevio/gh-repo-stats

gh-extension github-cli github-cli-extension repository-stats-cli-tool

Last synced: about 2 months ago
JSON representation

A GitHub CLI extension that fetches and displays statistics for any GitHub repository.

Host: GitHub
URL: https://github.com/eziodevio/gh-repo-stats
Owner: EzioDEVio
License: mit
Created: 2024-03-24T22:05:02.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-05-07T18:53:21.000Z (8 months ago)
Last Synced: 2024-11-13T13:48:57.778Z (about 2 months ago)
Topics: gh-extension, github-cli, github-cli-extension, repository-stats-cli-tool
Language: Go
Homepage:
Size: 7.14 MB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

[![Trivy Vulnerability Scan](https://github.com/theslash84/gh-repo-stats/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/theslash84/gh-repo-stats/actions/workflows/trivy-scan.yml) ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) ![Last commit](https://img.shields.io/github/last-commit/theslash84/gh-repo-stats) ![Issues](https://img.shields.io/github/issues/theslash84/gh-repo-stats) ![Pull Requests](https://img.shields.io/github/issues-pr/theslash84/gh-repo-stats) ![Contributors](https://img.shields.io/github/contributors/theslash84/gh-repo-stats) ![Stars](https://img.shields.io/github/stars/theslash84/gh-repo-stats) ![Forks](https://img.shields.io/github/forks/theslash84/gh-repo-stats) ![Watchers](https://img.shields.io/github/watchers/theslash84/gh-repo-stats)
![Code size](https://img.shields.io/github/languages/code-size/theslash84/gh-repo-stats) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=EzioDEVio_gh-repo-stats&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=EzioDEVio_gh-repo-stats) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=EzioDEVio_gh-repo-stats)](https://sonarcloud.io/summary/new_code?id=EzioDEVio_gh-repo-stats) [![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/summary/new_code?id=EzioDEVio_gh-repo-stats) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=EzioDEVio_gh-repo-stats&metric=bugs)](https://sonarcloud.io/summary/new_code?id=EzioDEVio_gh-repo-stats)
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=EzioDEVio_gh-repo-stats&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=EzioDEVio_gh-repo-stats)

# gh-repo-stats

## 🚀 Overview

Welcome to **gh-repo-stats**, a refined GitHub CLI extension meticulously designed by [Mohammed Aldaraji](https://github.com/theslash84). This extension serves as a powerful tool in your CLI arsenal, offering instant access to essential statistics of any GitHub repository. With `gh-repo-stats`, key insights are merely a command away, providing you with a comprehensive overview of a repository's dynamics.

### 🎯 Purpose

Developed with a vision to streamline access to GitHub repository statistics, `gh-repo-stats` empowers developers, project managers, and open-source enthusiasts to retrieve crucial data swiftly and efficiently. Whether you're evaluating a project's engagement or monitoring its growth, `gh-repo-stats` provides the metrics you need directly in your command line.

## ✨ Key Features and Benefits

- **Comprehensive Metrics**: Gain insights into a repository's star count, fork count, open issues, watchers, and more.
- **Enhanced Readability**: With emojis and symbols, the output is not only informative but also visually appealing.
- **Streamlined Workflow**: `gh-repo-stats` optimizes your workflow by providing quick access to repository statistics, freeing up more time for development.
- **Open Source Collaboration**: As an open-source tool, `gh-repo-stats` welcomes contributions and enhancements from the community, fostering a collaborative environment for improvement.

## 🌟 Enhanced Repository Statistics

With `gh-repo-stats`, you can fetch a detailed set of repository statistics adorned with intuitive emojis and symbols, enhancing the interpretability and engagement of the output:

- 🌟 **Stars**: The number of stars the repository has received.
- 🍴 **Forks**: The count of forks indicating the repository's reach and collaboration.
- 🔓 **Open Issues**: The number of unresolved issues, reflecting the repository's activity and community engagement.
- 👀 **Watchers**: The watcher count, indicating the level of interest in the repository.
- 🔖 **Default Branch**: The name of the repository's default branch.
- 📦 **Archived Status**: Indicates whether the repository is archived.
- 👥 **Contributors**: The total number of contributors to the repository.
- 📌 **Total Commits**: The total number of commits, reflecting the repository's development activity.

## 🛠 Installation

Ensure you have the GitHub CLI installed on your system. If it's not yet installed, refer to the [official installation guide](https://cli.github.com/manual/installation).

Install `gh-repo-stats` using the following command:

```shell
gh extension install theslash84/gh-repo-stats
```

Experience the enhanced insights provided by `gh-repo-stats` with this simple installation!

## 🔍 Usage

To fetch repository statistics, execute:

```
gh repo-stats -owner -repo
```

**Example**: To retrieve stats for the `gh-repo-stats` repository:

```
gh repo-stats -owner theslash84 -repo gh-repo-stats
```

The command outputs a set of statistics, making repository analysis straightforward and efficient.

## 🤝 Contributing

Your contributions are invaluable to the continuous evolution of `gh-repo-stats`. If you have ideas, bug reports, or enhancements, please share them through issues and pull requests. Together, we can make `gh-repo-stats` even more robust and feature-rich.

## 📜 License

`gh-repo-stats` is released under the MIT License. For more details, please refer to the LICENSE file.

## 🌐 Sharing with GitHub Extension Library

Enhance the visibility of `gh-repo-stats` by sharing it with the GitHub extension library:

1. Visit your repository on GitHub.
2. Click on the "About" section to the right.
3. Add `gh-extension` to the "Topics" field.

By incorporating this topic, `gh-repo-stats` becomes part of a broader collection of GitHub CLI extensions, increasing its discoverability and utility for the community.

Thank you for exploring `gh-repo-stats`. Here's to many insightful analyses!