此命令用于快速搭建一个 WP-CLI 包的基础文件结构,包括命令文件、composer.json、测试框架等。适合开发者创建新的 WP-CLI 命令包时使用,可大幅减少初始化工作。
| 参数 | 说明 |
|---|---|
<name> |
新包的名称,格式为 作者/包名(例如 wp-cli/scaffold-package)。 |
--description=<description> |
包的人类可读描述。 |
--homepage=<homepage> |
包的主页,默认为 https://github.com/<name>。 |
--dir=<dir> |
指定命令的目标目录,默认为 WP-CLI 的 packages/local/ 目录。 |
--license=<license> |
包的许可证,默认为 MIT。 |
--require_wp_cli=<version> |
所需的 WP-CLI 版本,默认为 ^2.5。 |
--require_wp_cli_tests=<version> |
所需的 WP-CLI 测试框架版本,默认为 ^3.0.11。 |
--skip-tests |
不为集成测试生成文件。 |
--skip-readme |
不为包生成 README.md。 |
--skip-github |
不生成 GitHub 问题和拉取请求模板。 |
--skip-install |
脚手架后不安装包。 |
--force |
覆盖已存在的文件。 |
$ wp package install wp-cli/scaffold-package-command
$ wp scaffold package wp-cli/my-command
$ wp scaffold package wp-cli/my-command --description="A custom WP-CLI command" --license=GPL-2.0