8000 gh-861: Document GitHub CLI by za · Pull Request #882 · python/devguide · GitHub
[go: up one dir, main page]
Skip to content

gh-861: Document GitHub CLI #882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jul 1, 2022
Merged

gh-861: Document GitHub CLI #882

Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8fddf2c
gh-861 Initial commit to document GitHub CLI on gitbootcamp.rst
za Jun 6, 2022
6efc701
gh-861 Address feedback
za Jun 7, 2022
f2a28ed
gh-861 Add <pr-id>
za Jun 7, 2022
3a4e3fc
gh-861 Add short description and installation instruction.
za Jun 7, 2022
2b6804d
gh-861 Reformat the hyperlink
za Jun 7, 2022
f59b47a
gh-861 Make `gh auth login` in a separate section
za Jun 9, 2022
2ff396b
gh-861 Address feedback from @hugovk
za Jun 29, 2022
6347bf1
gh-861 Make the period not as part of the hyperlink.
za Jun 29, 2022
ca015b2
gh-8161 Change to lowercase
za Jun 29, 2022
4ff10c4
gh-861 No need to repeat CLI
za Jun 30, 2022
66effa3
gh-861 Simplified introduction paragraph
za Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions gitbootcamp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,3 +551,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 is a CLI (command-line interface) to work with GitHub.
For example, you can create pull requests and releases,
set alias commands, check PR statuses.

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>
0