gh-861: Document GitHub CLI (#882)

za · hugovk · web-flow · commit d88bf3a6141c · 2022-07-01T14:22:13.000+02:00
* gh-861 Initial commit to document GitHub CLI on gitbootcamp.rst * gh-861 Address feedback * Numbered list * ssh formatting * code block removal Reference: #882 (review) * gh-861 Add <pr-id> * gh-861 Add short description and installation instruction. * gh-861 Reformat the hyperlink * gh-861 Make `gh auth login` in a separate section and fix the broken link. * gh-861 Address feedback from @hugovk #882 (review) * gh-861 Make the period not as part of the hyperlink. * gh-8161 Change to lowercase Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * gh-861 No need to repeat CLI Feedback by @hugovk #882 (comment) * gh-861 Simplified introduction paragraph Feedback by @ezio-melotti #882 (comment) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
diff --git a/gitbootcamp.rst b/gitbootcamp.rst
@@ -536,3 +536,35 @@ To edit an open pull request that targets ``main``:
       git push git@github.com:<contributor>/cpython <pr_number>:<branch_name>
 
 5. Optionally, :ref:`delete the PR branch <deleting_branches>`.
+
+
+GitHub CLI
+----------
+
+`GitHub CLI <https://cli.github.com>`_ is a command-line
+interface that allows you to create, update, and check GitHub
+issues and pull requests.
+
+You can install GitHub CLI `by following these instructions
+<https://github.com/cli/cli#installation>`_. After installing,
+you need to authenticate::
+
+    gh auth login
+
+Examples of useful commands:
+
+* Create a PR::
+
+      gh pr create
+
+* Check out another PR::
+
+      gh pr checkout <pr-id>
+
+* Set ``ssh`` as the Git protocol::
+
+      gh config set git_protocol ssh
+
+* Set the browser::
+
+      gh config set browser <browser-path>
