Skip to content

Document how wp package install resolves a package name #255

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

Open
muneeb-ashraf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document how wp package install resolves a package name #255

Show file tree
Hide file tree
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,17 @@ wp package install <name|git|path|zip> [--insecure] [--interaction]
Packages are required to be a valid Composer package, and can be
specified as:

* Package name from WP-CLI's package index.
* Package name, such as `wp-cli/server-command`.
* Git URL accessible by the current shell user.
* Path to a directory on the local machine.
* Local or remote .zip file.

A package name is looked up in WP-CLI's package index, which is deprecated,
and then on Packagist. If neither has it, WP-CLI tries
`https://github.com/<package-name>.git` and then
`https://gitlab.com/<package-name>.git`. Set the `GITHUB_TOKEN` or
`GITLAB_TOKEN` environment variable to avoid rate limiting on that check.

Packages are installed to `~/.wp-cli/packages/` by default. Use the
`WP_CLI_PACKAGES_DIR` environment variable to provide a custom path.

Expand Down
8 changes: 7 additions & 1 deletion src/Package_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,17 @@ public function browse( $_, $assoc_args ) {
* Packages are required to be a valid Composer package, and can be
* specified as:
*
* * Package name from WP-CLI's package index.
* * Package name, such as `wp-cli/server-command`.
* * Git URL accessible by the current shell user.
* * Path to a directory on the local machine.
* * Local or remote .zip file.
*
* A package name is looked up in WP-CLI's package index, which is deprecated,
* and then on Packagist. If neither has it, WP-CLI tries
* `https://github.com/<package-name>.git` and then
* `https://gitlab.com/<package-name>.git`. Set the `GITHUB_TOKEN` or
* `GITLAB_TOKEN` environment variable to avoid rate limiting on that check.
*
* Packages are installed to `~/.wp-cli/packages/` by default. Use the
* `WP_CLI_PACKAGES_DIR` environment variable to provide a custom path.
*
Expand Down
Loading