Home

Awesome

github-interact-cli

<div align="center"> <h1>⚑️ github-interact-cli<br> <img src="https://img.shields.io/npm/v/github-interact-cli?color=%#80C73D&label=version"> <img src="https://img.shields.io/npm/dt/github-interact-cli?color=%#80C73D"> <img src="https://img.shields.io/npm/l/github-interact-cli?color=%#80C73D"> </h1> </div>

github-interact-cli lets you use GitHub right inside your terminal.

πŸ‘‰ FEATURES

🎩 INSTALLATION

Install the CLI globally. If you are windows user, run your command prompt/terminal as administrator. If you are macOS user, add sudo before the following command.

npm i -g github-interact-cli
<div align="center"> <img alt="installation" src="https://i.imgur.com/ClFFvhH.gif"> </div>

πŸ— SETUP

Type the following in the terminal to run the CLI.

github

CLI will start running. It will ask you to add a Personal Access Token & your GitHub Username. If you don't know what Personal Access Token is & how to create one, check this awesome guide by GitHub.

!Note: Be sure to give the token repo, admin:repo_hook & delete repo scopes .

<img alt="personal access token configurations" src="https://i.imgur.com/E30KXz8.png">

Once you are done, exit the CLI so that configurations can be saved & used again.

<img alt="done" src="https://i.imgur.com/fVdgewD.png">

! Note: This is one time thing. You will not have to do it again every time you run the CLI.

πŸ‘Œ Shortcuts

You can now use shortcuts to interact with the CLI. Just type any of the following in the terminal & hit <kbd>Enter</kbd>

github-new
github-delete
github-get
github-issue
github-email
github-stars

πŸ“¦ Create New Repo

Write the following in the terminal to run the CLI again.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>1</kbd> to Create a GitHub Repo. Then answer the next questions.

<img alt="done" src="https://i.imgur.com/bRPNnat.png">

Taa daa! The repo has been created. You can check it! πŸ₯‚

♻️ Delete your Existing Repo

Type the following in the terminal to run the CLI.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>2</kbd> to Create a GitHub Repo. Then enter the name of the repo you want to delete.

<img alt="done" src="https://i.imgur.com/fdpmK2O.png">

Taa daa! The repo has been deleted. πŸ™ŒπŸ»

! Note: Be sure to give your personal access token delete repo scope. If you don't know how to edit your current token, follow these steps.

<img alt="steps of editing personal access token" src="https://i.imgur.com/2s3lOJV.gif">

πŸš€ Get All Repos

Type the following in the terminal to run the CLI.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>3</kbd> to get all GitHub Public Repos of the any GitHub user. Next enter the username of the GitHub user you want to see the repos of.

<img alt="enter username" src="https://i.imgur.com/K0eW1yR.png">

Press <kbd>Enter</kbd>. And there you have it, folks! πŸ”₯

<img alt="done" src="https://i.imgur.com/kID3qMm.png">

⚠️ Open Issue

Type the following in the terminal to run the CLI.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>4</kbd> to Create a GitHub Issue. Then answer the next questions.

<img alt="done" src="https://i.imgur.com/bAp9IK5.png">

Click here to check the issue I just created in the screenshot.

βœ‰οΈ Get Public Email

Type the following in the terminal to run the CLI.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>5</kbd> to get public email of the GitHub user. Then enter the username of the GitHub user.

<img alt="done" src="https://i.imgur.com/huGK5nv.png">

⭐️Get Stargazers

Type the following in the terminal to run the CLI.

github

You will get this menu. πŸ”₯

<img alt="menu" src="https://i.imgur.com/ccwTAbs.png">

Enter <kbd>6</kbd> to get total number of stargazers of any GitHub repos. Then answer the next questions.

<img alt="done" src="https://i.imgur.com/TynjyHI.png">

πŸš€ FEATURE REQUEST

Use the Issues section if you want to request any feature or report an issue.

πŸ™ŒπŸ» PROPS

πŸ‘¨πŸ»β€πŸ’» AUTHOR

πŸ™‹πŸ»β€β™‚οΈ Hola! I am Saad, an undergrad Computer Science student. I developed this CLI to automate the repetitive ridiculous amount of things we have to do in GitHub. You can follow me at

⚑️ Other Projects

I have curated a detailed list of all the open-source projects I have authored. Do take out a moment and take a look.

πŸ”‘ LICENSE