From 01b7b935ff7df7c9782693538afb9633ccce200b Mon Sep 17 00:00:00 2001 From: Khairnar Saurabh Ravindra Date: Mon, 11 Oct 2021 09:13:09 +0530 Subject: [PATCH] docs(gh): add cheatsheet --- gh/README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 65 insertions(+), 7 deletions(-) diff --git a/gh/README.md b/gh/README.md index a423968..a6e7ed7 100644 --- a/gh/README.md +++ b/gh/README.md @@ -9,19 +9,77 @@ To update or switch versions, run `webi gh@stable` (or `@v1`, `@beta`, etc). ## Cheat Sheet -> `gh` doesn't exist and this text should have been replaced. It doesn't do -> anything, but what it does is useful because it is; everybody knows it. +> `gh` is cross-platform Github command-line. You can perform pull requests +> create-repo, isssues, fork and other GitHub functionalities right from your +> terminal while Working with Git and your code. -To run gh: +Installation: + +- For macOS and Windows [macOS/Windows](https://github.com/cli/cli/blob/trunk/README.md) +- For linux Installation on specific distribution [linux](https://github.com/cli/cli/blob/trunk/docs/install_linux.md) + +### Authentication + +Authenticate with your Github account. + +```bash +gh auth login +``` + +### Pull Request + +Create a pull request. + +```bash +gh pr create -t -b <body> +``` + +Check out pull requests locally. + +```bash +gh pr checkout +``` + +Check the status of yout pull requests. + +```bash +gh pr status +``` + +View Your pull requests' checks. + +```bash +gh pr check +``` + +### Issues + +View and filter a repository's open issues. + +```bash +gh issue list +``` + +### Release + +Create a new release. + +```bash +gh release create 0.1 +``` + +### Repo + +View repository READMEs. ```bash -gh +gh repo view ``` -### Add Baz Highlighting +### Create Shortcut -To run gh with both bar and baz highlighting turned on: +Create Shortcut for a gh command. ```bash -gh --bar=baz +gh alias set bugs 'issue list --label="bugs"' ``` -- 2.25.1