Home

Console Tool

• completion
• export-commands
• help
• list

deployhq:

• deployhq:connect-project-repo
• deployhq:connect-project-repository
• deployhq:create-project
• deployhq:create-project-server
• deployhq:rotate-project-private-key

github:

• github:create-repository
• github:export-pattern-to-repo
• github:update-repository-secret

jetpack:

• jetpack:export-site-plugins
• jetpack:list-site-modules
• jetpack:module-search
• jetpack:plugin-search
• jetpack:set-site-module-status
• jetpack:toggle-site-module

pressable:

• pressable:add-site-domain
• pressable:clone-site
• pressable:create-development-site
• pressable:create-production-site
• pressable:create-site
• pressable:create-site-collaborator
• pressable:delete-site-collaborator
• pressable:list-site-php-errors
• pressable:open-site-shell
• pressable:rotate-site-sftp-user-password
• pressable:rotate-site-wp-user-password
• pressable:run-site-wp-cli-command
• pressable:upload-site-icon

wpcom:

• wpcom:add-site-sticker
• wpcom:clone-site
• wpcom:connect-site-repository
• wpcom:create-production-site
• wpcom:create-site
• wpcom:delete-site-wp-user
• wpcom:list-site-plugins
• wpcom:list-site-stickers
• wpcom:list-sites
• wpcom:list-sites-stats-orders
• wpcom:list-sites-stats-summary
• wpcom:list-sites-with-sticker
• wpcom:remove-site-sticker
• wpcom:rotate-site-wp-user-password
• wpcom:run-site-wp-cli-command

completion

Dump the shell completion script

Usage

• completion [--debug] [--dev] [--no-autocomplete] [--] [<shell>]

The completion command dumps the shell completion script required to use shell autocompletion (currently, bash, fish, zsh completion are supported).

Static installation

Dump the script to a global completion file and restart your shell:

/usr/local/bin/team51 completion zsh | sudo tee $fpath[1]/_team51

Or dump the script to a local file and source it:

/usr/local/bin/team51 completion zsh > completion.sh

# source the file whenever you use the project
source completion.sh

# or add this line at the end of your "~/.zshrc" file:
source /path/to/completion.sh

Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.zshrc"):

eval "$(/Users/taco/team51-cli/team51-cli.php completion zsh)"

Arguments

shell

The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given

• Is required: no
• Is array: no
• Default: NULL

Options

--debug

Tail the completion debug log

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

export-commands

Exports all commands to a file in the specified format.

Usage

• export-commands [-f|--format FORMAT] [-d|--destination DESTINATION] [--dev] [--no-autocomplete]

Use this command to export all commands to a file in the specified format.

Options

--format|-f

The format to export the commands in. Accepted values are md, txt, json, and xml.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'md'

--destination|-d

If provided, the output will be saved inside the specified file instead of the terminal output.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

help

Display help for a command

Usage

• help [--format FORMAT] [--raw] [--dev] [--no-autocomplete] [--] [<command_name>]

The help command displays help for a given command:

/usr/local/bin/team51 help list

You can also output the help in other formats by using the --format option:

/usr/local/bin/team51 help --format=xml list

To display the list of available commands, please use the list command.

Arguments

command_name

The command name

• Is required: no
• Is array: no
• Default: 'help'

Options

--format

The output format (txt, xml, json, or md)

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'txt'

--raw

To output raw command help

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

list

List commands

Usage

• list [--raw] [--format FORMAT] [--short] [--dev] [--no-autocomplete] [--] [<namespace>]

The list command lists all commands:

/usr/local/bin/team51 list

You can also display the commands for a specific namespace:

/usr/local/bin/team51 list test

You can also output the information in other formats by using the --format option:

/usr/local/bin/team51 list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

/usr/local/bin/team51 list --raw

Arguments

namespace

The namespace name

• Is required: no
• Is array: no
• Default: NULL

Options

--raw

To output raw command list

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--format

The output format (txt, xml, json, or md)

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'txt'

--short

To skip describing commands' arguments

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

deployhq:connect-project-repository

Connects a project to a GitHub repository on DeployHQ.

Usage

• deployhq:connect-project-repository [--dev] [--no-autocomplete] [--] <project> <repository>
• deployhq:connect-project-repo

Use this command to connect a DeployHQ project to a GitHub repository.

Arguments

project

The slug of the DeployHQ project to connect.

• Is required: yes
• Is array: no
• Default: NULL

repository

The slug of the GitHub repository to connect.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

deployhq:create-project

Creates a new project on DeployHQ.

Usage

• deployhq:create-project [--zone-id ZONE-ID] [--template-id TEMPLATE-ID] [--repository REPOSITORY] [--dev] [--no-autocomplete] [--] <name>

Use this command to create a new project on DeployHQ.

Arguments

name

The name of the project to create.

• Is required: yes
• Is array: no
• Default: NULL

Options

--zone-id

The ID of the zone to create the project in. Defaults to North America (East).

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--template-id

The ID of the template to use for the project.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'pressable-included-integration'

--repository

The slug of the GitHub repository to connect the project to, if any.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

deployhq:create-project-server

Creates a new server for a project on DeployHQ.

Usage

• deployhq:create-project-server [--branch BRANCH] [--branch-source BRANCH-SOURCE] [--dev] [--no-autocomplete] [--] <project> <site> <name>

Use this command to create a new server for a project on DeployHQ.

Arguments

project

The permalink of the project to create the server for.

• Is required: yes
• Is array: no
• Default: NULL

site

The domain or numeric Pressable ID of the site to connect the server to.

• Is required: yes
• Is array: no
• Default: NULL

name

The name of the server to create.

• Is required: yes
• Is array: no
• Default: NULL

Options

--branch

The branch to deploy from.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--branch-source

The existing branch to create the new one off of if it does not exist.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

deployhq:rotate-project-private-key

Rotates the private key in a DeployHQ project.

Usage

• deployhq:rotate-project-private-key [--multiple MULTIPLE] [--dev] [--no-autocomplete] [--] [<project>]

Use this command to rotate the private key in one or more DeployHQ projects.

Arguments

project

The permalink of the project to rotate the private key for.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Determines whether to process multiple projects. Accepted values are all or a comma-separated list of project permalinks.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

github:create-repository

Creates a new GitHub repository on github.com in the organization specified by the GITHUB_API_OWNER constant.

Usage

• github:create-repository [--homepage HOMEPAGE] [--description DESCRIPTION] [--type TYPE] [--custom-properties CUSTOM-PROPERTIES] [--dev] [--no-autocomplete] [--] <name>

This command allows you to create a new Github repository.

Arguments

name

The name of the repository to create.

• Is required: yes
• Is array: no
• Default: NULL

Options

--homepage

A URL with more information about the repository.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--description

A short, human-friendly description for this project.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--type

The name of the template repository to use, if any. One of either project, plugin, or issues. Default empty repo.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--custom-properties

The custom properties to set for the repository.

• Accept value: yes
• Is value required: yes
• Is multiple: yes
• Is negatable: no
• Default: array ()

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

github:export-pattern-to-repo

Exports a block pattern from a site to a GitHub.

Usage

• github:export-pattern-to-repo [--dev] [--no-autocomplete] [--] <site> <pattern-name> <category-slug>

This command exports a specified block pattern into a category within a GitHub repository.

Arguments

site

ID or URL of the Pressable site to run the command on.

• Is required: yes
• Is array: no
• Default: NULL

pattern-name

The unique identifier of the block pattern to export (e.g., namespace/pattern-name).

• Is required: yes
• Is array: no
• Default: NULL

category-slug

The slug of the category under which the pattern should be exported. It should be lowercase with hyphens instead of spaces (e.g., featured-patterns).

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

github:update-repository-secret

Updates the value of a GitHub repository secret.

Usage

• github:update-repository-secret [--multiple MULTIPLE] [--dev] [--no-autocomplete] [--] <secret-name> [<repository>]

This command allows you to update a GitHub repository secret. If the secret does not exist on the repository, it gets skipped.

Arguments

secret-name

The name of the secret to update.

• Is required: yes
• Is array: no
• Default: NULL

repository

The slug of the GitHub repository to operate on.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Determines whether the 'repository' argument is optional or not. Accepts 'all' or a comma-separated list of repository slugs.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

jetpack:export-site-plugins

Export a list of plugins installed on WPCOM or Jetpack-connected sites.

Usage

• jetpack:export-site-plugins [--multiple MULTIPLE] [-d|--destination DESTINATION] [--dev] [--no-autocomplete] [--] [<site>]

Use this command to export a list of plugins installed on sites. Only sites with an active Jetpack connection to WPCOM are included.

Arguments

site

Domain or WPCOM ID of the site to list the plugins for.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Determines whether the site argument is optional or not. Accepted values are all or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--destination|-d

The destination file to export the plugins to.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

jetpack:list-site-modules

Lists the status of Jetpack modules on a given site.

Usage

• jetpack:list-site-modules [--dev] [--no-autocomplete] [--] <site>

Use this command to show a list of Jetpack modules on a given site together with their status. This command requires that the given site has an active Jetpack connection to WPCOM.

Arguments

site

Domain or WPCOM ID of the site to fetch the information for.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

jetpack:module-search

List all connected sites where a given Jetpack module is in a given status.

Usage

• jetpack:module-search [--status STATUS] [--dev] [--no-autocomplete] [--] <module>

Use this command to find which sites have a given Jetpack module in a given status. Only sites with an active Jetpack connection to WPCOM are searched through.

Arguments

module

The module to check the status of.

• Is required: yes
• Is array: no
• Default: NULL

Options

--status

The status to check for. Must be one of 'on' or 'off'. By default, 'on'.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

jetpack:plugin-search

List all connected sites where a given plugin is installed.

Usage

• jetpack:plugin-search [--partial] [--version-search VERSION-SEARCH] [--version-operator VERSION-OPERATOR] [--dev] [--no-autocomplete] [--] <plugin>

Use this command to find which sites have a given plugin installed. Only sites with an active Jetpack connection to WPCOM are searched through.

Arguments

plugin

The plugin to search for. The term will be matched against the folder name, the main file name, and the textdomain.

• Is required: yes
• Is array: no
• Default: NULL

Options

--partial

Whether to do a partial search. If set, the plugin term will be matched against partial strings.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version-search

The version of the plugin to search for.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--version-operator

The operator to use for the version comparison.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

jetpack:set-site-module-status

Sets the status of Jetpack modules on a given site.

Usage

• jetpack:set-site-module-status [--dev] [--no-autocomplete] [--] <site> <module> [<status>]
• jetpack:toggle-site-module

Use this command to enable/disable a given Jetpack module on a given site. This command requires that the given site has an active Jetpack connection to WPCOM.

Arguments

site

Domain or WPCOM ID of the site to set the module status on.

• Is required: yes
• Is array: no
• Default: NULL

module

The module to set the status for.

• Is required: yes
• Is array: no
• Default: NULL

status

The status to set the module to. Must be one of 'on' or 'off'. By default, 'on'.

• Is required: no
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:add-site-domain

Adds a given domain to a given Pressable site and optionally sets it as primary.

Usage

• pressable:add-site-domain [--primary] [--dev] [--no-autocomplete] [--] <site> <domain>

This command allows you to add a new domain to a Pressable site. If the given domain is to also be set as primary, then any 1Password entries using the old URL will be updated as well.

Arguments

site

ID or URL of the site to add the domain to.

• Is required: yes
• Is array: no
• Default: NULL

domain

The domain to add to the site.

• Is required: yes
• Is array: no
• Default: NULL

Options

--primary

Set the given domain as the primary one.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:clone-site

Creates a development clone of an existing Pressable site.

Usage

• pressable:clone-site [--datacenter DATACENTER] [--branch BRANCH] [--skip-safety-net] [--dev] [--no-autocomplete] [--] <site> [<label>]
• pressable:create-development-site

Use this command to create a development clone of an existing Pressable site.

Arguments

site

The site to clone.

• Is required: yes
• Is array: no
• Default: NULL

label

The suffix to append to the site name. Defaults to development.

• Is required: no
• Is array: no
• Default: NULL

Options

--datacenter

The datacenter to clone the site in. Defaults to the datacenter of the given site.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--branch

The branch to deploy to the site from. Defaults to develop.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--skip-safety-net

Skip the installation of SafetyNet as a mu-plugin.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:create-site

Creates a new production site on Pressable.

Usage

• pressable:create-site [--datacenter DATACENTER] [--repository REPOSITORY] [--dev] [--no-autocomplete] [--] <name>
• pressable:create-production-site

Use this command to create a new production site on Pressable.

Arguments

name

The name of the site to create. Probably the same as the project name.

• Is required: yes
• Is array: no
• Default: NULL

Options

--datacenter

The datacenter to create the site in. Defaults to Dallas, Texas.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--repository

The GitHub repository to deploy to the site from.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:create-site-collaborator

Creates a new Pressable site collaborator.

Usage

• pressable:create-site-collaborator [--dev] [--no-autocomplete] [--] <site> <email>

Use this command to create a new Pressable site collaborator.

Arguments

site

The domain or numeric Pressable ID of the site to create the collaborator on.

• Is required: yes
• Is array: no
• Default: NULL

email

The email address of the collaborator to create.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:delete-site-collaborator

Deletes a collaborator from Pressable sites.

Usage

• pressable:delete-site-collaborator [--multiple MULTIPLE] [--delete-wp-user] [--dev] [--no-autocomplete] [--] <email> [<site>]

Use this command to delete a collaborator from Pressable sites.

Arguments

email

The email address of the collaborator to delete.

• Is required: yes
• Is array: no
• Default: NULL

site

The site ID or domain to delete the collaborator from.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Process multiple sites. Use all for all sites, related for related sites, or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--delete-wp-user

Also delete the WordPress user associated with the collaborator.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:list-site-php-errors

Displays the most recent PHP errors for a given Pressable site.

Usage

• pressable:list-site-php-errors [--limit LIMIT] [--format FORMAT] [--severity SEVERITY] [--source SOURCE] [--audit] [--dev] [--no-autocomplete] [--] [<site>]

This command allows you to figure out what is preventing a website from loading.

Arguments

site

ID or URL of the site to display the errors for.

• Is required: no
• Is array: no
• Default: NULL

Options

--limit

The number of distinct PHP fatal errors to return.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 5

--format

The format to output the logs in. Accepts either list, table or raw.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'list'

--severity

The error severity to filter by. Valid values are "User", "Warning", "Deprecated", and "Fatal error". Default all.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--source

Where to retrieve the PHP errors from. Accepts either file, api, or auto.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'auto'

--audit

Whether to check all the sites for the ones with the highest number of errors.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:open-site-shell

Opens an interactive SSH or SFTP shell to a given Pressable site.

Usage

• pressable:open-site-shell [--shell-type SHELL-TYPE] [--dev] [--no-autocomplete] [--] <site>

Use this command to open an interactive SSH or SFTP shell to a given Pressable site.

Arguments

site

The domain or numeric Pressable ID of the site to open the shell to.

• Is required: yes
• Is array: no
• Default: NULL

Options

--shell-type

The type of shell to open. Accepts either "ssh" or "sftp". Default "ssh".

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'ssh'

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:rotate-site-sftp-user-password

Rotates the SFTP user password of a given user on Pressable sites.

Usage

• pressable:rotate-site-sftp-user-password [-u|--user USER] [--multiple MULTIPLE] [--dry-run] [--dev] [--no-autocomplete] [--] [<site>]

This command allows you to rotate the SFTP password of users on Pressable sites.

Arguments

site

The domain or numeric Pressable ID of the site on which to rotate the SFTP user password.

• Is required: no
• Is array: no
• Default: NULL

Options

--user|-u

The ID, email, or username of the site SFTP user for which to rotate the password. The default is [email protected].

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--multiple

Determines whether the 'site' argument is optional or not. Accepted values are 'related', 'all', or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dry-run

Execute a dry run. It will output all the steps, but will keep the current SFTP user password. Useful for checking whether a given input is valid.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:rotate-site-wp-user-password

Rotates the WordPress user password of a given user on Pressable sites.

Usage

• pressable:rotate-site-wp-user-password [-u|--user USER] [--multiple MULTIPLE] [--dry-run] [--dev] [--no-autocomplete] [--] [<site>]

This command allows you to rotate the WP password of users on Pressable sites. Finally, it attempts to update the 1Password values of rotated passwords as well.

Arguments

site

The domain or numeric Pressable ID of the site on which to rotate the WP user password.

• Is required: no
• Is array: no
• Default: NULL

Options

--user|-u

The email of the site WP user for which to rotate the password. The default is [email protected].

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--multiple

Determines whether the site argument is optional or not. Accepted values are related, all, or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dry-run

Execute a dry run. It will output all the steps, but will keep the current WP user password. Useful for checking whether a given input is valid.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:run-site-wp-cli-command

Runs a given WP-CLI command on a given Pressable site.

Usage

• pressable:run-site-wp-cli-command [--multiple MULTIPLE] [--skip-output] [--dev] [--no-autocomplete] [--] <wp-cli-command> [<site>]

This command allows you to run an arbitrary WP-CLI command on a Pressable site.

Arguments

wp-cli-command

The WP-CLI command to run.

• Is required: yes
• Is array: no
• Default: NULL

site

The domain or numeric Pressable ID of the site to open the shell to.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Determines whether the site argument is optional or not. Accepted values are all or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--skip-output

Skip outputting the response to the console.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

pressable:upload-site-icon

Uploads the site icon as apple-touch-icon.png to the Pressable sites.

Usage

• pressable:upload-site-icon [--dev] [--no-autocomplete] [--] <site>

If a site is displaying a white square icon when bookmarking it in iOS, this command may help fix it.

Arguments

site

ID or URL of the site to upload the icon to.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:add-site-sticker

Add a given sticker to a WPCOM site.

Usage

• wpcom:add-site-sticker [--dev] [--no-autocomplete] [--] <site> <sticker>

Use this command to associate a new sticker with a WPCOM site.

Arguments

site

Domain or WPCOM ID of the site to add the sticker to.

• Is required: yes
• Is array: no
• Default: NULL

sticker

Sticker to add to the site. Any sticker with the team-51- prefix and the blocked-from-atomic-transfer sticker.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:clone-site

Creates a new staging site for a WordPress.com site.

Usage

• wpcom:clone-site [--branch BRANCH] [--skip-safety-net] [--dev] [--no-autocomplete] [--] <site>

Use this command to create a staging staging site for an existing WordPress.com site.

Arguments

site

The site for which to create the staging site.

• Is required: yes
• Is array: no
• Default: NULL

Options

--branch

The branch to deploy to the site from. Defaults to develop.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--skip-safety-net

Skip the installation of SafetyNet as a mu-plugin.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:connect-site-repository

Connects a WordPress.com site to a GitHub repository for deployments.

Usage

• wpcom:connect-site-repository [--branch BRANCH] [--target_dir TARGET_DIR] [--deploy] [--dev] [--no-autocomplete] [--] <site> <repository>

Use this command to connect a WordPress.com site to a GitHub repository for deployments.

Arguments

site

Domain or WPCOM ID of the site to connect the repository to.

• Is required: yes
• Is array: no
• Default: NULL

repository

The slug of the GitHub repository to connect.

• Is required: yes
• Is array: no
• Default: NULL

Options

--branch

The branch to deploy from.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--target_dir

The target directory to deploy to.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--deploy

Trigger a deployment after the connection is complete.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:create-site

Creates a new production site on WordPress.com.

Usage

• wpcom:create-site [--repository REPOSITORY] [--dev] [--no-autocomplete] [--] <name>
• wpcom:create-production-site

Use this command to create a new production site on WordPress.com.

Arguments

name

The name of the site to create. Probably the same as the project name.

• Is required: yes
• Is array: no
• Default: NULL

Options

--repository

The GitHub repository to deploy to the site from.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:delete-site-wp-user

Deletes a WP user from WPCOM sites.

Usage

• wpcom:delete-site-wp-user [--multiple MULTIPLE] [--dry-run] [--dev] [--no-autocomplete] [--] <email> [<site>]

Use this command to delete a WP user from WPCOM sites.

Arguments

email

The email address of the user to delete.

• Is required: yes
• Is array: no
• Default: NULL

site

The domain or WPCOM ID of the site to delete the user from.

• Is required: no
• Is array: no
• Default: NULL

Options

--multiple

Determines whether the site argument is optional or not. Accepted values are all or a comma-separated list of site IDs or domains.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dry-run

Perform a dry run without actually deleting users

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-site-plugins

List the plugins installed on a WPCOM site.

Usage

• wpcom:list-site-plugins [--dev] [--no-autocomplete] [--] <site>

Use this command to list the plugins installed on a WPCOM site.

Arguments

site

Domain or WPCOM ID of the site to list the plugins for.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-site-stickers

Lists the WPCOM stickers associated with a given site.

Usage

• wpcom:list-site-stickers [--dev] [--no-autocomplete] [--] <site>

Use this command to show a list of WPCOM stickers associated with a given site.

Arguments

site

Domain or WPCOM ID of the site to fetch the stickers for.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-sites

Lists all the sites connected to the team's WPCOM account.

Usage

• wpcom:list-sites [--audit [AUDIT]] [--export EXPORT] [--export-format EXPORT-FORMAT] [--export-exclude EXPORT-EXCLUDE] [--dev] [--no-autocomplete]

This command will output a summary of the sites connected to WPCOM.

Options

--audit

Produces a full list of sites, with reasons why they were or were not filtered. Audit values include full, for including all sites, no-staging to exclude staging sites, as well as a general column/text based exclusive filter, eg. is_private will include only private sites.

• Accept value: yes
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: NULL

--export

If provided, the output will be saved inside the specified file in addition to the terminal.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--export-format

The format to export the sites in. Accepted values are json, and csv.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: 'csv'

--export-exclude

Exclude columns from the export option. Possible values: Site Name, Domain, Site ID, and Host.

• Accept value: yes
• Is value required: yes
• Is multiple: yes
• Is negatable: no
• Default: array ()

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-sites-stats-orders

Exports WooCommerce order statistics for all sites connected to the team's WPCOM account.

Usage

• wpcom:list-sites-stats-orders [--unit UNIT] [--date DATE] [--export EXPORT] [--dev] [--no-autocomplete]

This command will output the top grossing WooCommerce sites we support with dollar amounts and an over amount summed across all of our sites.

Options

--unit

Options: day, week, month, year.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--date

Options: For --unit=day: YYYY-MM-DD For --unit=week: YYYY-W## For --unit=month: YYYY-MM For --unit=year: YYYY.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--export

If provided, the output will be saved inside the specified file in CSV format in addition to the terminal.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-sites-stats-summary

Exports summary statistics for all sites connected to the team's WPCOM account.

Usage

• wpcom:list-sites-stats-summary [--num NUM] [--date DATE] [--period PERIOD] [--export EXPORT] [--dev] [--no-autocomplete]

This command will output a summary of WPCOM stats across all of our sites.

Options

--num

Number of periods to include in the results.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--date

The date that determines the most recent period for which results are returned. Format is Y-m-d.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--period

The output will return results over the past [num] days/weeks/months/years, the last one being the one including [date].

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--export

If provided, the output will be saved inside the specified file in CSV format in addition to the terminal.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:list-sites-with-sticker

Lists the Blog IDs of sites with a specific sticker.

Usage

• wpcom:list-sites-with-sticker [--dev] [--no-autocomplete] [--] <sticker>

Use this command to show a list of WPCOM Sites with a specific sticker.

Arguments

sticker

Sticker to fetch the sites with.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:remove-site-sticker

Removes a given sticker from a WPCOM site.

Usage

• wpcom:remove-site-sticker [--dev] [--no-autocomplete] [--] <site> <sticker>

Use this command to disassociate a sticker from a WPCOM site.

Arguments

site

Domain or WPCOM ID of the site to remove the sticker from.

• Is required: yes
• Is array: no
• Default: NULL

sticker

Sticker to remove from the site.

• Is required: yes
• Is array: no
• Default: NULL

Options

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:rotate-site-wp-user-password

Rotates the WordPress user password of a given user on WPCOM sites.

Usage

• wpcom:rotate-site-wp-user-password [-u|--user USER] [--multiple MULTIPLE] [--dry-run] [--dev] [--no-autocomplete] [--] [<site>]

This command allows you to rotate the WP password of users on WPCOM sites. Finally, it attempts to update the 1Password values of rotated passwords as well.

Arguments

site

The domain or numeric WPCOM ID of the site on which to rotate the WP user password.

• Is required: no
• Is array: no
• Default: NULL

Options

--user|-u

The email of the site WP user for which to rotate the password. The default is [email protected].

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--multiple

Determines whether the site argument is optional or not. Accepted values are all or a comma-separated list of site IDs or URLs.

• Accept value: yes
• Is value required: yes
• Is multiple: no
• Is negatable: no
• Default: NULL

--dry-run

Execute a dry run. It will output all the steps, but will keep the current WP user password. Useful for checking whether a given input is valid.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

wpcom:run-site-wp-cli-command

Runs a given WP-CLI command on a given WordPress.com site.

Usage

• wpcom:run-site-wp-cli-command [--skip-output] [--dev] [--no-autocomplete] [--] <site> <wp-cli-command>

This command allows you to run an arbitrary WP-CLI command on a WordPress.com site.

Arguments

site

The domain or numeric WordPress.com ID of the site to open the shell to.

• Is required: yes
• Is array: no
• Default: NULL

wp-cli-command

The WP-CLI command to run.

• Is required: yes
• Is array: no
• Default: NULL

Options

--skip-output

Skip outputting the response to the console.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--dev

Run the CLI tool in developer mode.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--no-autocomplete

Do not provide options to initialization questions.

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--help|-h

Display help for the given command. When no command is given display help for the list command

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--quiet|-q

Do not output any message

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--verbose|-v|-vv|-vvv

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--version|-V

Display this application version

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false

--ansi|--no-ansi

Force (or disable --no-ansi) ANSI output

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: yes
• Default: NULL

--no-interaction|-n

Do not ask any interactive question

• Accept value: no
• Is value required: no
• Is multiple: no
• Is negatable: no
• Default: false