Create a distribution archive based on a project's .distignore file.
For a plugin in a directory ‘wp-content/plugins/hello-world’, this command creates a distribution archive ‘wp-content/plugins/hello-world.zip’.
You can specify files or directories you’d like to exclude from the archive with a .distignore file in your project repository:
.distignore .editorconfig .git .gitignore .travis.yml circle.yml
Use one distribution archive command for many projects, instead of a bash script in each project.
wp dist-archive command by installing the command's package:
wp package install wp-cli/dist-archive-command
Once the package is successfully installed, the
wp dist-archive command will appear in the list of available commands.
- Path to the project that includes a .distignore file.
- Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
- Automatically create the target directory as needed.
- Set the archive extract directory name. Defaults to project directory name.
- Choose the format for the archive.
GLOBAL PARAMETERS GLOBAL PARAMETERS
These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
||Path to the WordPress files.|
||Pretend request came from given URL. In multisite, this argument is how the target site is specified.|
||Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “docker-compose-run”, “vagrant”).|
||Perform operation against a remote WordPress installation over HTTP.|
||Set the WordPress user.|
||Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.|
||Skip loading all themes, or a comma-separated list of themes.|
||Skip loading all installed packages.|
||Load PHP file before running the command (may be used more than once).|
||Execute PHP code before running the command (may be used more than once).|
||Load WordPress in a given context.|
||Whether to colorize the output.|
||Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.|
||Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.|
||Suppress informational messages.|
Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.