README

列出、安装和删除 WP-CLI 包。

使用

此包实现了以下命令

wp package

列出、安装和删除 WP-CLI 包。

wp package

WP-CLI 包是由 WP-CLI 构建的社区维护项目。它们可以包含 WP-CLI 命令，也可以以某种方式扩展 WP-CLI。

从命令食谱中了解如何创建自己的命令。

示例

# 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 development version of the package.
$ wp package install wp-cli/server-command
Installing package wp-cli/server-command (dev-main)
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

浏览可安装的 WP-CLI 包。

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

列出可安装的包，来自包索引。尽管出于向后兼容的原因包索引将保留，但它已被弃用，不会再进一步更新。请参阅 wp-cli/ideas#51 了解其可能的替代方案。

选项

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

可用字段

这些字段将默认显示每个包

名称
描述
作者
版本

没有可选的字段。

示例

$ 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 install

安装一个 WP-CLI 包。

wp package install <name|git|path|zip> [--insecure]

包必须是有效的 Composer 包，可以指定为

从 WP-CLI 包索引中的包名。
当前 shell 用户可以访问的 Git URL。
本地计算机上的目录路径。
本地或远程 .zip 文件。

默认情况下，包安装在 ~/.wp-cli/packages/。使用环境变量 WP_CLI_PACKAGES_DIR 提供自定义路径。

当安装本地目录时，WP-CLI 仅注册对目录的引用。如果您移动或删除该目录，WP-CLI 的引用将损坏。

当安装 .zip 文件时，WP-CLI 将包提取到 ~/.wp-cli/packages/local/<package-name>。

如果需要 GitHub token 授权，可以使用 GitHub 个人访问令牌 (https://github.com/settings/tokens)。以下命令将添加 GitHub 个人访问令牌到 Composer 的全局配置：composer config -g github-oauth.github.com <GITHUB_TOKEN> 一旦添加，用于 <GITHUB_TOKEN> 的值将用于未来的授权请求。

选项

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

示例

# Install a package hosted at a git URL.
$ wp package install runcommand/hook

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

# 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 list

列出已安装的 WP-CLI 包。

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

选项

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

可用字段

这些字段将默认显示每个包

名称
作者
版本
更新
更新版本

这些字段是可选的

描述

示例

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

wp package update

将所有已安装的 WP-CLI 包更新到最新版本。

wp package update

示例

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

wp package uninstall

卸载一个 WP-CLI 包。

wp package uninstall <name> [--insecure]

选项

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

示例

# 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-CLI 本身中，无需额外安装。

要安装此包的最新版本，覆盖 WP-CLI 中包含的版本，请运行

wp package install [email protected]:wp-cli/package-command.git

贡献

我们感谢您主动为这个项目做出贡献。

贡献不仅仅是代码。我们鼓励您根据自己的能力以最适合的方式来贡献，比如编写教程、在当地聚会中演示、帮助其他用户解答支持问题或修订我们的文档。

要了解更多信息，请查看WP-CLI的贡献指南。本包遵循这些政策和指南。

报告一个错误

认为你发现了一个错误？我们非常希望你能帮助我们修复它。

在创建新的问题之前，你应该搜索现有的问题，看看是否已经存在对该错误的解决方案，或者它是否已经在更新的版本中修复。

一旦你进行了搜索并发现没有为你发现的错误开放或已修复的问题，请创建一个新的问题。尽可能提供详细信息，并在可能的情况下提供重现步骤。有关更多指导，请查看我们的错误报告文档。

创建一个拉取请求

想要贡献一个新功能？请首先打开一个新的问题来讨论该功能是否适合本项目。

一旦你决定投入时间来提交你的拉取请求，请遵循我们的拉取请求创建指南，以确保这是一个愉快的体验。关于在本地工作此包的详细信息，请参见"设置"。

支持

GitHub问题不是用于一般支持问题的地方，但你还可以尝试其他途径：https://wp-cli.org/#support

此README.md文件是通过使用wp scaffold package-readme（文档）从项目的代码库动态生成的。要建议更改，请提交针对代码库相应部分的拉取请求。

wp-cli / package-command

维护者

详细信息