https://github.com/cqb13/github-stats
A CLI tool for getting information on github repositories and users.
https://github.com/cqb13/github-stats
cli git-scraping github-rest-api github-stats rust-cli
Last synced: 9 months ago
JSON representation
A CLI tool for getting information on github repositories and users.
- Host: GitHub
- URL: https://github.com/cqb13/github-stats
- Owner: cqb13
- License: mit
- Created: 2024-04-22T14:45:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T01:57:03.000Z (10 months ago)
- Last Synced: 2025-03-29T10:33:41.959Z (9 months ago)
- Topics: cli, git-scraping, github-rest-api, github-stats, rust-cli
- Language: Rust
- Homepage:
- Size: 91.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Stats (gstats)
`gstats` is a CLI tool that provides comprehensive statistics and information about GitHub repositories and users.
## Installation
`gstats` can be installed either by cloning the repository and building from source or by downloading a precompiled executable from the release page. Below are the instructions for both methods:
### Installing from Source
1. **Clone the Repository**:
Clone `gstats` from GitHub to your local machine using the following command:
```bash
git clone https://github.com/cqb13/github-stats
cd gstats
```
2. **Build and Install with Cargo** (requires Rust's cargo tool):
If you have Rust and Cargo installed, you can directly build and install the application using:
```bash
cargo build --release
./target/release/gstats install
```
### Installing from Precompiled Executables
1. **Download the Latest Release**:
Go to the [Releases page](rhttps://github.com/cqb13/github-stats/releases) of the `gstats` repository and download the appropriate executable for your operating system.
2. **Run Install Command**:
After downloading, you need to run the installation command. Assuming you have downloaded `gstats.exe`, you can install it by navigating to the download location and running:
```bash
./gstats install
```
This command will set up `gstats` on your system, making it ready for use.
### Post-Installation
After installing `gstats`, you can run `gstats help` to see all available commands and how to use them. Make sure that the installation path of `gstats` is added to your system's PATH, so it can be run from any terminal session.
## Usage
```bash
USAGE:
gstats [COMMAND] [OPTIONS]
COMMANDS:
version - Prints version information
install - Installs the files and directories
repo - Displays general information about a repositoy
user (required) The user who owns the repository
repository (required) The name of the repository
-o --output File path to save the json
-d --display Converts the json to an easier format (will remove some data)
repo - Displays general information about a repositoy
user (required) The user who owns the repository
repository (required) The name of the repository
-o --output File path to save the json
-d --display Converts the json to an easier format (will remove some data)
releases - Displays informatiom about github releases
user (required) The user who owns the repository
repository (required) The name of the repository
-i --individual Displays downloads per release along with total downloads
-l --link Displays download links for releases (if not individiual then for latest)
-o --output File path to save the json
-a --all Saves all the json from the request insteaad of a cleaned up version
-d --display Converts the json to an easier format (will remove some data)
user - Displays information about a github user
user (required) The user who owns the repository
-o --output File path to save the json
-d --display Converts the json to an easier format (will remove some data)
followers - Displays the followers of a github user
user (required) The user who owns the repository
-t --toal Displays the total follower count
-o --output File path to save the json
-d --display Converts the json to an easier format (will remove some data)
following - Displays the users a github user is following
user (required) The user who owns the repository
-t --toal Displays the total follower count
-o --output File path to save the json
-d --display Converts the json to an easier format (will remove some data)
```
## Contributing
Contributions are welcome! Feel free to fork this repository and submit pull requests.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.