docs(gh): add cheatsheet
authorKhairnar Saurabh Ravindra <srkhairnar23@gmail.com>
Mon, 11 Oct 2021 03:43:09 +0000 (09:13 +0530)
committerAJ ONeal <aj@therootcompany.com>
Sun, 14 Nov 2021 08:49:27 +0000 (08:49 +0000)
gh/README.md

index a4239689fa9ee03c1b67ace4bd43fc9de8c60d76..a6e7ed7d71cf06312e8cccccccfb605e47980a2a 100644 (file)
@@ -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 <title> -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"'
 ```