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.

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

Document support for GitHub token authentication #177

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@ reference breaks.
When installing a .zip file, WP-CLI extracts the package to
`~/.wp-cli/packages/local/<package-name>`.

If Github token authorization is required, a GitHub Personal Access Token
(https://github.com/settings/tokens) can be used. The following command
will add a GitHub Personal Access Token to Composer's global configuration:
composer config -g github-oauth.github.com <GITHUB_TOKEN>
Once this has been added, the value used for <GITHUB_TOKEN> will be used
for future authorization requests.

**OPTIONS**

<name|git|path|zip>
Expand Down
7 changes: 7 additions & 0 deletions src/Package_Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,13 @@ public function browse( $_, $assoc_args ) {
* When installing a .zip file, WP-CLI extracts the package to
* `~/.wp-cli/packages/local/<package-name>`.
*
* If Github token authorization is required, a GitHub Personal Access Token
* (https://github.com/settings/tokens) can be used. The following command
* will add a GitHub Personal Access Token to Composer's global configuration:
* composer config -g github-oauth.github.com <GITHUB_TOKEN>
* Once this has been added, the value used for <GITHUB_TOKEN> will be used
* for future authorization requests.
*
* ## OPTIONS
*
* <name|git|path|zip>
Expand Down