https://github.com/msaaddev/github-interact-cli
π© Interact with GItHub right inside your terminal
https://github.com/msaaddev/github-interact-cli
cli github github-api github-cli github-issues github-stars issues javascript node-cli repo repository
Last synced: 7 months ago
JSON representation
π© Interact with GItHub right inside your terminal
- Host: GitHub
- URL: https://github.com/msaaddev/github-interact-cli
- Owner: msaaddev
- License: mit
- Created: 2020-04-06T22:10:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-23T13:42:35.000Z (over 4 years ago)
- Last Synced: 2024-10-29T01:37:12.584Z (about 1 year ago)
- Topics: cli, github, github-api, github-cli, github-issues, github-stars, issues, javascript, node-cli, repo, repository
- Language: JavaScript
- Homepage: https://twitter.com/MSaaddev
- Size: 647 KB
- Stars: 45
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
β‘οΈ github-interact-cli
`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
```
## π 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](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) 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.
`οΌ 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 Enter
- 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. π₯
Enter 1 to Create a GitHub Repo. Then answer the next questions.
Taa daa! The repo has been created. You can [check](https://github.com/msaaddev/git-test-repo) it! π₯
### β»οΈ Delete your Existing Repo
Type the following in the terminal to run the CLI.
```
github
```
You will get this menu. π₯
Enter 2 to Create a GitHub Repo. Then enter the name of the repo you want to delete.
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. π₯
Enter 3 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.
Press Enter. And there you have it, folks! π₯
### β οΈ Open Issue
Type the following in the terminal to run the CLI.
```
github
```
You will get this menu. π₯
Enter 4 to Create a GitHub Issue. Then answer the next questions.
[Click here](https://github.com/msaaddev/vidly/issues/9) 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. π₯
Enter 5 to get public email of the GitHub user. Then enter the username of the GitHub user.
### βοΈGet Stargazers
Type the following in the terminal to run the CLI.
```
github
```
You will get this menu. π₯
Enter 6 to get total number of stargazers of any GitHub repos. Then answer the next questions.
## π FEATURE REQUEST
Use the [Issues](https://github.com/msaaddev/github-interact-cli/issues) section if you want to request any feature or report an issue.
## ππ» PROPS
- Header Image by [Iqra Fatima](https://github.com/iqrafatimame)
## π¨π»βπ» 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
- [Twitter](https://twitter.com/msaaddev)
- [Facebook](https://www.facebook.com/msaaddev)
- [Blog](https://msaad.dev)
## β‘οΈ Other Projects
I have curated a [detailed list](https://github.com/msaaddev/open-source) of all the open-source projects I have authored. Do take out a moment and take a look.
## π LICENSE
- MIT