GitHub CLI Tool

A simple command-line interface (CLI) tool to retrieve details of a GitHub account.

Table of Contents

1. Installation
2. Usage
3. Example
4. Error Handling
5. Credits

Installation

You can install gh-deets via npm by running the following command:

npm install -g gh-deets

Usage

After installing the package globally, you can use it in the command line as follows:

gh-deets <GitHub-Username>

Replace with the desired GitHub username.

Example

gh-deets octocat

Output:

=============== Getting repository details for octocat ===============

Name: The Octocat
Number of public repositories: 11
Followers: 2437
Following: 9

Error Handling

• If no GitHub username is provided:

Please, pass in GitHub username

• If the GitHub username is not found:

Cannot find repository details for <GitHub-Username>

• If an error occurs during the API request:

Sorry, something went wrong

Credits

This NPM package was developed by Tobiloba Odukoya.