chore: make Prettier
[webi-installers/.git] / gh / README.md
index 3ac08de9bed60c7f39845e8e9de00258a981c3a9..117178fb11f5c3a7cfed4edcaad14ebfa56618f0 100644 (file)
@@ -5,27 +5,83 @@ tagline: |
   `gh` is GitHub on the command line.
 ---
 
-## Updating and Switch versions
+To update or switch versions, run `webi gh@stable` (or `@v1`, `@beta`, etc).
+
+## Cheat Sheet
+
+> `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.
+
+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
-webi gh
+gh auth login
 ```
 
-## Cheat Sheet
+### 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
+```
 
-> `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.
+### Repo
 
-To run gh:
+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"'
 ```