Awesome
<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
- π¦ Create a new repo
- β»οΈ Delete your existing repo
- π Get all public repos of any GitHub User
- β οΈ Open issue in any repo.
- βοΈ Get public email of any GitHub user
- βοΈ Get stargazers of any GitHub repo
π© 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 .
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>
- New Repo
github-new
- Delete Repo
github-delete
- Get All Public Repo
github-get
- Open Issue
github-issue
- Get Email
github-email
- Get Stars
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.
- Open your GitHub account settings
- Select Developer settings from the left sidebar
- Click on Personal access tokens
- You will see a list of personal access tokens. Select the token you created earlier for github-interact-cli.
- Scroll down the scope list and select delete_repo
- Then scroll at the bottom & select Update token
π 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
- Header Image by Iqra Fatima
π¨π»βπ» 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
- MIT