wp-cli/package-command

README

wp-cli/package-command

Lists, installs, and removes WP-CLI packages.

Quick links: Using | Installing | Contributing | Support

Using

This package implements the following commands:

wp package

Lists, installs, and removes WP-CLI packages.

wp package

WP-CLI packages are community-maintained projects built on WP-CLI. They can contain WP-CLI commands, but they can also just extend WP-CLI in some way.

Learn how to create your own command from the Commands Cookbook

EXAMPLES

# List installed packages.
$ wp package list
+-----------------------+------------------+----------+-----------+----------------+
| name                  | authors          | version  | update    | update_version |
+-----------------------+------------------+----------+-----------+----------------+
| wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev        |
+-----------------------+------------------+----------+-----------+----------------+

# Install the latest stable version of the package.
$ wp package install wp-cli/server-command
Installing package wp-cli/server-command (^2.0)
Updating /home/person/.wp-cli/packages/composer.json to require the package...
Using Composer to install the package...
---
Loading composer repositories with package information
Updating dependencies
Resolving dependencies through SAT
Dependency resolution completed in 0.005 seconds
Analyzed 732 packages to resolve dependencies
Analyzed 1034 rules to resolve dependencies
 - Installing package
Writing lock file
Generating autoload files
---
Success: Package installed.

# Uninstall package.
$ wp package uninstall wp-cli/server-command
Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json
Removing repository details from /home/person/.wp-cli/packages/composer.json
Removing package directories and regenerating autoloader...
Success: Uninstalled package.

wp package browse

Browses WP-CLI packages available for installation.

wp package browse [--fields=<fields>] [--format=<format>]

Lists packages available for installation from the Package Index. Although the package index will remain in place for backward compatibility reasons, it has been deprecated and will not be updated further. Please refer to wp-cli/ideas#51 to read about its potential replacement.

OPTIONS

[--fields=<fields>]
	Limit the output to specific fields. Defaults to all fields.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - ids
	  - json
	  - yaml
	---

AVAILABLE FIELDS

These fields will be displayed by default for each package:

name
description
authors
version

There are no optionally available fields.

EXAMPLES

$ wp package browse --format=yaml
---
10up/mu-migration:
  name: 10up/mu-migration
  description: A set of WP-CLI commands to support the migration of single WordPress instances to multisite
  authors: Nícholas André
  version: dev-main, dev-develop
aaemnnosttv/wp-cli-dotenv-command:
  name: aaemnnosttv/wp-cli-dotenv-command
  description: Dotenv commands for WP-CLI
  authors: Evan Mattson
  version: v0.1, v0.1-beta.1, v0.2, dev-main, dev-dev, dev-develop, dev-tests/behat
aaemnnosttv/wp-cli-http-command:
  name: aaemnnosttv/wp-cli-http-command
  description: WP-CLI command for using the WordPress HTTP API
  authors: Evan Mattson
  version: dev-main

wp package get

Gets information about an installed WP-CLI package.

wp package get <name> [--fields=<fields>] [--format=<format>] [--skip-update-check]

OPTIONS

<name>
	Name of the package to get information for.

[--fields=<fields>]
	Limit the output to specific fields. Defaults to all fields.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - yaml
	---

[--skip-update-check]
	Skip checking for updates. This is faster and avoids authentication issues with GitHub or Composer repositories.

AVAILABLE FIELDS

These fields will be displayed by default for each package:

name
authors
version
update
update_version

These fields are optionally available:

description

EXAMPLES

# Get information about an installed package.
$ wp package get wp-cli/scaffold-package-command
+----------------+---------------------------------+
| Field          | Value                           |
+----------------+---------------------------------+
| name           | wp-cli/scaffold-package-command |
| authors        | Daniel Bachhuber                |
| version        | dev-main                        |
| update         | available                       |
| update_version | 2.x-dev                         |
+----------------+---------------------------------+

# Get the version of a package.
$ wp package get wp-cli/server-command --fields=version --format=json
{"version":"dev-main"}

wp package install

Installs a WP-CLI package.

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, 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.

When installing a local directory, WP-CLI simply registers a reference to the directory. If you move or delete the directory, WP-CLI's 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>
	Name, git URL, directory path, or .zip file for the package to install.
	Names can optionally include a version constraint
	(e.g. wp-cli/server-command:@stable).

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

[--interaction]
	Control interactive mode. Use `--no-interaction` to disable prompts (interactive by default). Useful for scripting.

EXAMPLES

# Install the latest stable version of a package.
$ wp package install runcommand/hook

# Install a specific version.
$ wp package install wp-cli/server-command:2.0.0

# Install with caret operator (allows non-breaking updates).
$ wp package install wp-cli/server-command:^1.0

# Install with tilde operator (allows patch-level updates).
$ wp package install wp-cli/server-command:~1.2

# Install the latest stable version (explicitly specified).
$ wp package install wp-cli/server-command:@stable

# Install from a development branch.
$ wp package install wp-cli/server-command:dev-main

# Install a package hosted at a GitLab.com URL.
$ wp package install https://gitlab.com/foo/wp-cli-bar-command.git

# Install a package in a .zip file.
$ wp package install google-sitemap-generator-cli.zip

wp package is-installed

Checks if a given package is installed.

wp package is-installed <name>

Returns exit code 0 when installed, 1 when uninstalled.

OPTIONS

<name>
	The package to check.

EXAMPLES

# Check whether "foo/bar" is installed; exit status 0 if installed, otherwise 1
$ wp package is-installed foo/bar
$ echo $?
1

wp package list

Lists installed WP-CLI packages.

wp package list [--fields=<fields>] [--format=<format>] [--skip-update-check]

OPTIONS

[--fields=<fields>]
	Limit the output to specific fields. Defaults to all fields.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - ids
	  - json
	  - yaml
	---

[--skip-update-check]
	Skip checking for updates. This is faster and avoids authentication issues with GitHub or Composer repositories.

AVAILABLE FIELDS

These fields will be displayed by default for each package:

name
authors
version
update
update_version

These fields are optionally available:

description

EXAMPLES

# List installed packages.
$ wp package list
+-----------------------+------------------+----------+-----------+----------------+
| name                  | authors          | version  | update    | update_version |
+-----------------------+------------------+----------+-----------+----------------+
| wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev        |
+-----------------------+------------------+----------+-----------+----------------+

# List installed packages without checking for updates.
$ wp package list --skip-update-check
+-----------------------+------------------+----------+--------+----------------+
| name                  | authors          | version  | update | update_version |
+-----------------------+------------------+----------+--------+----------------+
| wp-cli/server-command | Daniel Bachhuber | dev-main | none   |                |
+-----------------------+------------------+----------+--------+----------------+

wp package path

Gets the path to an installed WP-CLI package, or the package directory.

wp package path [<name>]

If you want to contribute to a package, this is a great way to jump to it.

OPTIONS

[<name>]
	Name of the package to get the directory for.

EXAMPLES

# Get package path.
$ wp package path
/home/person/.wp-cli/packages/

# Get path to an installed package.
$ wp package path wp-cli/server-command
/home/person/.wp-cli/packages/vendor/wp-cli/server-command

# Change directory to package path.
$ cd $(wp package path) && pwd
/home/vagrant/.wp-cli/packages

wp package update

Updates installed WP-CLI packages to their latest version.

wp package update [<package-name>...] [--interaction]

[<package-name>...]
	One or more package names to update. If not specified, all packages will be updated.

[--interaction]
	Control interactive mode. Use `--no-interaction` to disable prompts (interactive by default). Useful for scripting.

EXAMPLES

# Update all packages.
$ wp package update
Using Composer to update packages...
---
Loading composer repositories with package information
Updating dependencies
Resolving dependencies through SAT
Dependency resolution completed in 0.074 seconds
Analyzed 1062 packages to resolve dependencies
Analyzed 22383 rules to resolve dependencies
Writing lock file
Generating autoload files
---
Success: Packages updated.

# Update a specific package.
$ wp package update wp-cli/server-command
Using Composer to update packages...
---
Loading composer repositories with package information
Updating dependencies
Writing lock file
Generating autoload files
---
Success: Package updated successfully.

wp package uninstall

Uninstalls a WP-CLI package.

wp package uninstall <name> [--insecure] [--interaction]

OPTIONS

<name>
	Name of the package to uninstall.

[--insecure]
	Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.

[--interaction]
	Control interactive prompts. Use `--no-interaction` to disable interactive questions (useful for scripting).

EXAMPLES

# Uninstall package.
$ wp package uninstall wp-cli/server-command
Removing require statement for package 'wp-cli/server-command' from /home/person/.wp-cli/packages/composer.json
Removing repository details from /home/person/.wp-cli/packages/composer.json
Removing package directories and regenerating autoloader...
Success: Uninstalled package.

Installing

This package is included with WP-CLI itself, no additional installation necessary.

To install the latest version of this package over what's included in WP-CLI, run:

wp package install git@github.com:wp-cli/package-command.git

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience. See "Setting up" for details specific to working on this package locally.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

GitHub issues aren't for general support questions. For support resources and next steps, see the WP-CLI Support page: https://make.wordpress.org/cli/handbook/support/

This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.

README