docs(gh): add cheatsheet

2026-04-19 08:26:39 +00:00 · 2021-10-11 09:13:09 +05:30
parent a1c6d570e8
commit 01b7b935ff
1 changed files with 65 additions and 7 deletions
--- 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
+gh auth login
 ```

-### Add Baz Highlighting
+### Pull Request

-To run gh with both bar and baz highlighting turned on:
+Create a pull request.

 ```bash
-gh --bar=baz
+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 repo view
+```
+
+### Create Shortcut
+
+Create Shortcut for a gh command.
+
+```bash
+gh alias set bugs 'issue list --label="bugs"'
 ```