DEV Community

loading...
Cover image for Getting Started with GitHub CLI

Getting Started with GitHub CLI

onyxcode profile image Dan ・2 min read

Original post on my blog as part of my #2Articles1Week.

GitHub CLI is a wonderful new tool released by GitHub in an effort to bring GitHub to the terminal. In this tutorial, I will be showing you how to setup, install and use some basic features of GitHub CLI.

Installation

Because of the amount of install methods, I've taken the liberty of creating a separate article dedicated to installation methods.

Authentication

When you first try to run gh, it will ask you to authenticate with your GitHub account.

gh auth login
Enter fullscreen mode Exit fullscreen mode

Select if you are authenticating with a GitHub Enterprise Server, or GitHub.com. In this tutorial, I will be authenticating with GitHub.com.

? What account do you want to log into?  [Use arrows to move, type to filter]
> GitHub.com
  GitHub Enterprise Server
Enter fullscreen mode Exit fullscreen mode

Next, select if you wish to authenticate with a web browser, or with an authentication token. To keep it simple, I'll authenticate with a web browser.

? How would you like to authenticate?  [Use arrows to move, type to filter]
> Login with a web browser
  Paste an authentication token
Enter fullscreen mode Exit fullscreen mode

Make sure to copy your one-time code before pressing "Enter" to open the authentication window.

! First copy your one-time code: <your code will be here>
- Press Enter to open github.com in your browser...
Enter fullscreen mode Exit fullscreen mode

By57wWKumX.png

After entering your activation code, you will be brought to the OAuth page.

NYs6clge0f.png

After authorizing, and confirming your password, you will be brought to this page.

4wWImySCyF.png

Congratulations! You are now authenticated! Returning to the terminal, you will be greeted with this message.

✓ Authentication complete. Press Enter to continue...
Enter fullscreen mode Exit fullscreen mode

One last thing!

? Choose default git protocol  [Use arrows to move, type to filter]
> HTTPS
  SSH
Enter fullscreen mode Exit fullscreen mode

I'd recommend using HTTPS, since it's the most widely used protocol, so I'll be choosing it.

✓ Configured git protocol
✓ Logged in as onyxcode
Enter fullscreen mode Exit fullscreen mode

Congrats! You're done setting up GitHub CLI!

Usage Examples

Full documentation at cli.github.com/manual.

  • Create a public gist
gh gist create --public hello.py
Enter fullscreen mode Exit fullscreen mode
  • Clone a repository
gh repo clone onyxcode/hazy
Enter fullscreen mode Exit fullscreen mode
  • List issues for a repository
gh issue list -R Rapptz/discord.py
Enter fullscreen mode Exit fullscreen mode
  • Download latest release
gh release download -R microsoft/winget-cli
Enter fullscreen mode Exit fullscreen mode

In closing

I hope you found this article helpful! If you did, share and like!

Discussion (0)

pic
Editor guide