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 distibution archive command for many projects, instead of a bash script in each project.

INSTALLING #INSTALLING

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

Top ↑

OPTIONS #OPTIONS

<path>

Path to the project that includes a .distignore file.

[<target>]

Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.

[--format=<format>]

Choose the format for the archive.
---
default: zip
options:
– zip
– targz
---

Top ↑

GLOBAL PARAMETERS #GLOBAL PARAMETERS

These global parameters have the same behavior across all commands and affect how WP-CLI interacts with WordPress.

Argument	Description
--path=<path>	Path to the WordPress files.
--url=<url>	Pretend request came from given URL. In multisite, this argument is how the target site is specified.
--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]	Perform operation against a remote server over SSH (or a container using scheme of “docker”, “docker-compose”, “vagrant”).
--http=<http>	Perform operation against a remote WordPress installation over HTTP.
--user=<id\|login\|email>	Set the WordPress user.
--skip-plugins[=<plugins>]	Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded.
--skip-themes[=<themes>]	Skip loading all themes, or a comma-separated list of themes.
--skip-packages	Skip loading all installed packages.
--require=<path>	Load PHP file before running the command (may be used more than once).
--[no-]color	Whether to colorize the output.
--debug[=<group>]	Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help.
--prompt[=<assoc>]	Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values.
--quiet	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.