{"componentChunkName":"component---src-pages-markdown-remark-fields-slug-js","path":"/engineering/github-cli-tool/","result":{"data":{"markdownRemark":{"id":"594e8ca3-33d1-5382-a73c-df84d49c633c","excerpt":"The GitHub CLI is a recent GitHub released tool that takes tasks of issue / PR management to the terminal. It will be a useful tool that will put more of our…","html":"

The GitHub CLI is a recent GitHub released tool that takes tasks of issue / PR management to the terminal. It will be a useful tool that will put more of our workflow for software creation into the textual domain rather than the visual domain. It’s just called gh.

\n

**Installation of GitHub CLI 💡**

\n

GitHub CLI has releases with significant operating systems, visit the installation page and find instructions on how to install GitHub CLI for your operating system.

\n

For [Windows] and [macOS], you will use the package managers to update and maintain GitHub CLI, and for Linux users, you may need to grab the software from the latest release website.

\n

Here are examples of the installation instructions for each compatible platform:

\n

→ Windows

\n
scoop bucket add github-gh https://github.com/cli/scoop-gh.gitscoop install gh
\n

→ macOS

\n
brew install github
\n

→ Debian/Ubuntu Linux

\n
sudo apt install git && sudo dpkg -i gh_*_linux_amd64.deb
\n

→ Fedora/Centos Linux

\n
sudo yum localinstall gh_*_linux_amd64.rpm
\n

→ Arch Linux

\n
yay -S github-cli
\n

You’ll need to authenticate your account after you install GitHub CLI. Running any command would activate this process of authentication(via OAuth). Well, you can use Git CLI.\n\"Auhtorize\"

\n

**What is CLI really doing? 🤔**

\n

The GitHub CLI lets you handle issues/ PRs / repositories from inside your console. Let’s have a look at it:

\n
gh issue [status, list, view, create]\ngh pr [status, list, view, checkout, create]\ngh repo [view, create, clone, fork]\ngh help
\n

\"gh

\n

It should be said that gh is not the same stuff as git. It’s because gh just adds GitHub tools to the terminal. Version management is yet to be managed with git.

\n

**CLI Commands ➫**

\n

We’re going to cover a bunch of exciting commands. Let’s use the official Angular.js repo to run gh commands

\n

Clone the Angular repo, and navigate to the repository. You can either clone the repo through HTTPS/ ssh/ Git CLI. I’m going to clone the repo through git CLI since we are working on GIT CLI.

\n

Let’s execute the $gh issue --help see what commands are available.

\n
gh issue --help  \nWork with GitHub issues\nUSAGE\n  gh issue <command> [flags]\nCORE COMMANDS\n  close:      Close issue\n  create:     Create a new issue\n  list:       List and filter issues in this repository\n  reopen:     Reopen issue\n  status:     Show the status of relevant issues\n  view:       View an issue\nFLAGS\n  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO format\nINHERITED FLAGS\n  --help   Show help for command\nARGUMENTS\n  An issue can be supplied as an argument in any of the following \n  formats:\n  - by number, e.g. "123"; or\n  - by URL, e.g. "https://github.com/OWNER/REPO/issues/123".\nEXAMPLES\n  $ gh issue list\n  $ gh issue create --label bug\n  $ gh issue view --web\nLEARN MORE\n  Use 'gh <command> <subcommand> --help' for more information about a command.\n  Read the manual at https://cli.github.com/manual
\n

It’s Time to view Problems/issues in the angular repo.😁

\n
gh issue list
\n

\"Angular

\n

**Pull Requests 🤖**

\n

It is now possible to build a Pull Request (PR) on the terminal. You will perform $gh pr create right after you have committed a feature or bug branch. This interactively creates the pull request.😉

\n

Let’s execute the $gh pr --help see what commands are available.

\n
Work with GitHub pull requests\nUSAGE\n  gh pr <command> [flags]\nCORE COMMANDS\n  checkout:   Check out a pull request in git\n  checks:     Show CI status for a single pull request\n  close:      Close a pull request\n  create:     Create a pull request\n  diff:       View changes in a pull request\n  list:       List and filter pull requests in this repository\n  merge:      Merge a pull request\n  ready:      Mark a pull request as ready for review\n  reopen:     Reopen a pull request\n  review:     Add a review to a pull request\n  status:     Show status of relevant pull requests\n  view:       View a pull request\nFLAGS\n  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO format\nINHERITED FLAGS\n  --help   Show help for command\nARGUMENTS\n  A pull request can be supplied as an argument in any of the following formats:\n  - by number, e.g. "123";\n  - by URL, e.g. "https://github.com/OWNER/REPO/pull/123"; or\n  - by the name of its head branch, e.g. "patch-1" or "OWNER:patch-1".\nEXAMPLES\n  $ gh pr checkout 353\n  $ gh pr create --fill\n  $ gh pr view --web\nLEARN MORE\n  Use 'gh <command> <subcommand> --help' for more information about a command.\n  Read the manual at https://cli.github.com/manual
\n

**Let’s view some of it:👀**

\n

current PR’s in the repo:

\n

$ gh pr list\n\"Angular

\n

*Let’s view an individual pr:*

\n

I’m going with the first pull request #38899. Through gh cmd $ gh pr view 38899.

\n
refactor(compiler): simplify visitor logic for attributes\nDraft • atscott wants to merge 1 commit into master from testrefactor\nLabels: cla: yes, comp: compiler, state: WIP, target: patch\nMilestone: needsTriage\nThe logic for computing identifiers, specifically for bound attributes can  \n  be simplified by using the value span of the binding rather than the source span.\nView this pull request on GitHub: https://github.com/angular/angular/pull/38899
\n

**Repository 🤖**

\n

Let’s execute the $gh repo --help see what commands are available

\n
Work with GitHub repositories\nUSAGE\n  gh repo <command> [flags]\nCORE COMMANDS\n  clone:      Clone a repository locally\n  create:     Create a new repository\n  fork:       Create a fork of a repository\n  view:       View a repository\nINHERITED FLAGS\n  --help   Show help for command\nARGUMENTS\n  A repository can be supplied as an argument in any of the following formats:\n  - "OWNER/REPO"\n  - by URL, e.g. "https://github.com/OWNER/REPO"\nEXAMPLES\n  $ gh repo create\n  $ gh repo clone cli/cli\n  $ gh repo view --web\nLEARN MORE\n  Use 'gh <command> <subcommand> --help' for more information about a command.\n  Read the manual at https://cli.github.com/manual
\n

It is better to clone a repository using the gh command than with the git command. I have done this above. Only through gh cmd, I have cloned angular repo.

\n
$ gh repo clone angular/angular\n$ gh repo fork\n- Forking angular/angular...
\n

Start functioning. You should create a new PR after this ($gh pr create)! It’s sort of remarkable that all of that element is now available in the terminal!😍

\n

**Gist 🐱‍🚀**

\n

It is now simple to create a gist on GitHub from the terminal using the CLI cmd.

\n
gh gist create < file >
\n

**Conclusion🙀**

\n

Git CLI's primary objective is to \"minimize context switching\" by allowing you to continue inside your terminal/console, rather than opening your browser to access GitHub. For additional functionality and knowledge on using the current resources, you may link to the manual.

\n","headings":[],"fields":{"slug":"/engineering/github-cli-tool/"},"frontmatter":{"metatitle":null,"metadescription":null,"description":"Learn about GitHub CLI tool and how/when to use it","title":"GitHub CLI Tool ⚒","canonical":null,"date":"October 05, 2020","updated_date":null,"tags":["Cloud","GIT","Version control"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5384615384615385,"src":"/static/67f9c8247a3c5142d5ef1f220d1e512a/96324/GitHub%20CLI%20Tool.webp","srcSet":"/static/67f9c8247a3c5142d5ef1f220d1e512a/1c9b5/GitHub%20CLI%20Tool.webp 200w,\n/static/67f9c8247a3c5142d5ef1f220d1e512a/f1752/GitHub%20CLI%20Tool.webp 400w,\n/static/67f9c8247a3c5142d5ef1f220d1e512a/96324/GitHub%20CLI%20Tool.webp 757w","sizes":"(max-width: 757px) 100vw, 757px"}}},"author":{"id":"Saravanan Vijayamuthu","github":"SaravananVijayamuthu","bio":"Software Developer intern at Digilocker. Looking for a challenging role in a reputable organization to utilize my technical, database, and management skills for the growth of the organization as well as to enhance my knowledge about new and emerging trends in the IT sector.","avatar":null}}}},"pageContext":{"id":"594e8ca3-33d1-5382-a73c-df84d49c633c","fields__slug":"/engineering/github-cli-tool/","__params":{"fields__slug":"engineering"}}},"staticQueryHashes":["1171199041","1384082988","1711371485","1753898100","2100481360","229320306","23180105","528864852"]}