a6e7ed7d71cf06312e8cccccccfb605e47980a2a
[webi-installers/.git] / gh / README.md
1 ---
2 title: GitHub CLI
3 homepage: https://github.com/cli/cli
4 tagline: |
5   `gh` is GitHub on the command line.
6 ---
7
8 To update or switch versions, run `webi gh@stable` (or `@v1`, `@beta`, etc).
9
10 ## Cheat Sheet
11
12 > `gh` is cross-platform Github command-line. You can perform pull requests
13 > create-repo, isssues, fork and other GitHub functionalities right from your
14 > terminal while Working with Git and your code.
15
16 Installation:
17
18 - For macOS and Windows [macOS/Windows](https://github.com/cli/cli/blob/trunk/README.md)
19 - For linux Installation on specific distribution [linux](https://github.com/cli/cli/blob/trunk/docs/install_linux.md)
20
21 ### Authentication
22
23 Authenticate with your Github account.
24
25 ```bash
26 gh auth login
27 ```
28
29 ### Pull Request
30
31 Create a pull request.
32
33 ```bash
34 gh pr create -t <title> -b <body>
35 ```
36
37 Check out pull requests locally.
38
39 ```bash
40 gh pr checkout
41 ```
42
43 Check the status of yout pull requests.
44
45 ```bash
46 gh pr status
47 ```
48
49 View Your pull requests' checks.
50
51 ```bash
52 gh pr check
53 ```
54
55 ### Issues
56
57 View and filter a repository's open issues.
58
59 ```bash
60 gh issue list
61 ```
62
63 ### Release
64
65 Create a new release.
66
67 ```bash
68 gh release create 0.1
69 ```
70
71 ### Repo
72
73 View repository READMEs.
74
75 ```bash
76 gh repo view
77 ```
78
79 ### Create Shortcut
80
81 Create Shortcut for a gh command.
82
83 ```bash
84 gh alias set bugs 'issue list --label="bugs"'
85 ```