Skip to content
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

Add authentication instructions to README #1329

Closed
wants to merge 1 commit into from
Closed

Add authentication instructions to README #1329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ complement existing completion scripts that ship with git.
* [hub bash completion](https://github.com/github/hub/blob/master/etc/hub.bash_completion.sh)
* [hub zsh completion](https://github.com/github/hub/blob/master/etc/hub.zsh_completion)

Authentication
--------------

Many hub commands must authenticate against GitHub to operate. Often, hub will prompt you for your credentials when they are needed.

The best way to authenticate hub without prompting is to set the environment variable GITHUB_TOKEN to the value of a [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) that you create for this purpose.

Meta
----

Expand Down