Skip to content
TommusRhodus edited this page Oct 2, 2026 · 6 revisions

Team51 CLI 12afc43 (2026-10-02)

deployhq:

github:

jetpack:

poseidon:

pressable:

wpcom:

completion

Dump the shell completion script

Usage

  • completion [--debug] [--dev] [--force-update] [--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 "$(/usr/local/bin/team51 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:add-checklist

Adds a checklist to a GitHub repository.

Usage

  • github:add-checklist [--skip-issue] [--a8c] [--partner-pays-wpcom] [--retain-jetpack-likes] [--sensei] [--woocommerce] [--wpcom-to-pressable-migration] [--site-redesign] [--dev] [--force-update] [--no-autocomplete] [--] <checklist> <repository> <host>

This command adds a checklist to a GitHub repository.

Arguments

checklist

The checklist to add. (launch, migrate-pressable-dns, qa-engineer)

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

repository

The slug of the repository to add the checklist to.

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

host

The hosting platform of the site. (pressable, wpcom-atomic, wpcom-simple)

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

Options

--skip-issue

Skip creating the issue on the repository. Checklist text will be output to the terminal instead.

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

--a8c

This site is an a8c property or product website.

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

--partner-pays-wpcom

The partner will be paying for their plans and subscriptions.

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

--retain-jetpack-likes

Jetpack likes will need to be retained during migration.

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

--sensei

The site has Sensei installed.

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

--woocommerce

The site has WooCommerce installed.

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

--wpcom-to-pressable-migration

The site has previously been hosted on WordPress.com or WordPress VIP.

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

--site-redesign

This site already has a Team 51 GitHub code repository.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--no-code-theme [NO-CODE-THEME]] [--classification CLASSIFICATION] [--custom-properties CUSTOM-PROPERTIES] [--dev] [--force-update] [--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 type of repository to create, which decides the template it is generated from. One of either project, no-code-project, plugin, issues, or empty. Default empty repo.

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

--no-code-theme

The name of the no-code theme to use for the repository.

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

--classification

The classification taxonomy tag to apply to the repository. One of: partner-site, plugin, theme, internal-tool, migration-tool, browser-extension, block-or-pattern, documentation, sandbox, scaffold.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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 [--preserve-images] [--dev] [--force-update] [--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

--preserve-images

Skip substition of placeholder images.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:self-add-to-repository

Adds your authenticated GitHub user (per gh CLI) to a repository as a push collaborator.

Usage

  • github:self-add-to-repository [--dev] [--force-update] [--no-autocomplete] [--] [<repository>]

This command resolves the currently authenticated GitHub username from the gh CLI and adds it to the given repository with push permission.

gh must be installed and logged in (gh auth login). Adding any other user is intentionally not supported.

Poseidon infrastructure repositories (poseidon-runner, poseidon-actions) are locked and cannot be joined through this command.

Arguments

repository

The slug of the GitHub repository to add yourself to.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:connection-triage

Triages Jetpack connection issues for sites and generates a report.

Usage

  • jetpack:connection-triage [--dev] [--force-update] [--no-autocomplete] [--] [<csv-path>]

Use this command to identify and analyze sites with Jetpack connection problems. It will check connection status and generate a CSV report with details about problematic connections.

You can either provide a CSV of specific sites to check, or run it without arguments to check all connected Jetpack sites.

Examples: Check all Jetpack sites: $ team51 jetpack:connection-triage

Check specific sites from a CSV: $ team51 jetpack:connection-triage /path/to/sites.csv

CSV Format: The input CSV should have 2 columns:

  • Column 1: Blog ID (numeric WordPress.com blog ID)
  • Column 2: Site URL (full URL including protocol)

Generated Report: The command generates a CSV report with the following columns:

  • Site ID: The WordPress.com blog ID
  • Site URL: The site's URL
  • Status: HTTP status code from connection check
  • New Blog ID: If site has a new connection, the new blog ID
  • Notes: Detailed findings and recommended actions

Arguments

csv-path

A path to a CSV with 2 columns, blog ID and url. If not provided, will check all connected Jetpack sites.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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-plugins

List the plugins installed on a WPCOM or Jetpack-connected site.

Usage

  • jetpack:list-site-plugins [--dev] [--force-update] [--no-autocomplete] [--] <site>

Use this command to list the plugins installed on a WPCOM or Jetpack-connected 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--status STATUS] [--export EXPORT] [--export-format EXPORT-FORMAT] [--export-exclude EXPORT-EXCLUDE] [--dev] [--force-update] [--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

--status

Only list plugins with this status. Accepted values are active and inactive. Lists both if omitted.

  • 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 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 ID, Site URL, Plugin Name, Plugin Slug, Plugin Version, and Plugin Status.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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-update

Updates a given plugin on connected sites where it is installed.

Usage

  • jetpack:plugin-update [--sites SITES] [--environment ENVIRONMENT] [--release RELEASE] [--refresh] [--dry-run] [--yes] [--dev] [--force-update] [--no-autocomplete] [--] <plugin>

Use this command to push a new plugin release to sites that have the plugin installed. Pass --sites to choose the targets: all for the whole connected fleet, a comma-separated list of site URLs and/or WPCOM IDs, or the path to a CSV whose first column holds the site URLs. Each site is updated via the WPCOM plugin update endpoint, which relies on the site having already detected a newer version from the plugin's own update source (wp.org, or a custom Update URI such as GitHub) — so a freshly published release may not reach every site immediately. If a release has been published but sites have not detected it yet, pass --refresh to make the targeted sites (those chosen with --sites) re-check for updates first (via the Atlantis lever), then update. Only sites with an active Jetpack connection to WPCOM are processed.

Arguments

plugin

The plugin to update. The term is matched exactly against the folder name, the main file name, and the textdomain.

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

Options

--sites

Which sites to update: all for the whole connected fleet, a comma-separated list of site URLs and/or numeric WPCOM IDs, or a path to a CSV file whose first column holds the site URLs.

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

--environment

Restrict the chosen sites by environment: staging acts only on sites whose URL contains "staging"; production skips every site whose URL contains "staging". Applied after --sites.

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

--release

The plugin version you are publishing. When set, each site is reported as updated / current / ahead / behind relative to it, so sites running a newer (e.g. test) build, or ones the release has not reached, are surfaced.

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

--refresh

Before updating, force the targeted sites to re-check for updates (via the Atlantis lever) so a just-published wp.org or WooCommerce.com release is detected even if their update cache has not refreshed yet. Runs synchronously against the sites you chose with --sites.

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

--dry-run

List the sites that would be updated without updating them.

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

--yes

Skip the confirmation prompt before updating.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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

poseidon:pr-review

Runs the Poseidon AI code review against a pull request using your local gh and claude CLIs.

Usage

  • poseidon:pr-review [--no-clone] [--model MODEL] [--max-turns MAX-TURNS] [--dev] [--force-update] [--no-autocomplete] [--] [<pr>]

This command fetches the Poseidon review prompt from a8cteam51/poseidon-actions (trunk), clones the PR locally, and runs the local claude CLI to review it.

It uses your own gh and claude authentication (not OpsOasis), so it works on any PR you have GitHub access to — including repos outside a8cteam51 such as Automattic.

The command is read-only: it prints the review to the terminal and posts nothing. The agent runs in Claude Code restricted mode, and its only GitHub access is gh pr view and gh pr diff.

Arguments

pr

Pull request URL (https://HOST/OWNER/REPO/pull/N, including GitHub Enterprise hosts) or OWNER/REPO#N for github.com. Prompted for if omitted.

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

Options

--no-clone

Skip cloning the repository; the agent reviews the diff only. Faster, but loses AGENTS.md/.agents grounding and all surrounding-code context.

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

--model

The Claude model to use.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: 'claude-opus-4-8'

--max-turns

The maximum number of agent turns.

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

--dev

Run the CLI tool in developer mode.

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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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-bilmur-tracking

Adds Bilmur tracking constants to wp-config for Pressable sites.

Usage

  • pressable:add-bilmur-tracking [--sites SITES] [--no-output] [--dry-run] [--dev] [--force-update] [--no-autocomplete] [--] [<site>]

Use this command to add Bilmur tracking constants to a given Pressable site, or to multiple sites using a CSV file.

Arguments

site

The site URL or domain to add tracking constants to.

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

Options

--sites

Path to a CSV file containing sites to process (Site,URL,Host,Done,Notes).

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

--no-output

Skip confirmations and minimize output.

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

--dry-run

Check constants without making any changes.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--project-template PROJECT-TEMPLATE] [--no-code-theme [NO-CODE-THEME]] [--repository REPOSITORY] [--dev] [--force-update] [--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

--project-template

The project template to use for the site. Either project or no-code-project. Defaults to project.

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

--no-code-theme

The name of the no-code theme to use for the repository if using the no-code-project template.

  • Accept value: yes
  • Is value required: no
  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:download-site-database

Download a SQL dump of the database from a Pressable site.

Usage

  • pressable:download-site-database [--destination DESTINATION] [--dev] [--force-update] [--no-autocomplete] [--] <site>

Use this command to export and download the database of a Pressable site. The dump is gzipped on the server before transfer, and decompressed locally unless the destination ends in .gz.

Arguments

site

Domain or Pressable site ID to download the database from.

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

Options

--destination

The destination path where the SQL dump will be saved. Ends in .gz to keep it compressed.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:download-site-plugins

Download plugins from a Pressable site.

Usage

  • pressable:download-site-plugins [--destination DESTINATION] [--dev] [--force-update] [--no-autocomplete] [--] <site>

Use this command to download all plugins from wp-content/plugins on a Pressable site.

Arguments

site

Domain or Pressable site ID to download plugins from.

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

Options

--destination

The destination path where the plugin archive will be saved.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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 concierge@wordpress.com.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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 concierge@wordpress.com.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:atlantis-status

Reports Atlantis plugin and module status across Jetpack-connected sites.

Usage

  • wpcom:atlantis-status [--site SITE] [--module MODULE] [--prod|--no-prod] [--issues-only|--no-issues-only] [--with-messages-only] [--export EXPORT] [--export-format EXPORT-FORMAT] [--export-exclude EXPORT-EXCLUDE] [--dev] [--force-update] [--no-autocomplete]

Calls the OpsOasis batch endpoint for a8csp-atlantis/v1/status and prints a per-site report. By default every connected site is queried; pass --site to inspect a single site. By default every Atlantis module is shown as its own column; pass --module to narrow to one. Sites without Atlantis installed are reported as not installed.

Options

--site

Restrict the report to a single site, identified by its WPCOM ID or URL. Skips the full fleet fetch.

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

--module

Restrict the report to a single module column. Accepted values: messages, colophon, tracking, autoupdates, bot-protection.

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

--prod|--no-prod

Exclude any site whose URL contains the substring "staging" (case-insensitive). Use --no-prod to suppress the prompt and include staging sites. When neither is set you will be prompted (unless --no-interaction).

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

--issues-only|--no-issues-only

Only show sites where Atlantis is not installed or at least one module is not on. Mandatory modules such as Bot Protection are never counted as issues (their inherit/off states are deliberate). Use --no-issues-only to suppress the prompt and show all sites. When neither is set you will be prompted (unless --no-interaction).

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

--with-messages-only

Only show sites that have at least one stored Atlantis custom message.

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

--export

If provided, the report will be saved to this 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 report 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. Possible values depend on the active --module flag; defaults to Site ID, Site URL, Atlantis Version, plus one column per Atlantis module.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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. Created off the repository default branch if it does not exist.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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 and configures deployment webhooks.

Usage

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

Use this command to connect a WordPress.com site to a GitHub repository for deployments, create a deployment webhook, and sync the webhook secret to OpsOasis.

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

--branch-source

The existing branch to create the deploy branch off of if it does not exist. Defaults to the repository default branch.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--project-template [PROJECT-TEMPLATE]] [--no-code-theme [NO-CODE-THEME]] [--dev] [--force-update] [--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

--project-template

The project template to use for the site. Either project or no-code-project. Defaults to project.

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

--no-code-theme

The name of the no-code theme to use for the repository if using the no-code-project template.

  • Accept value: yes
  • Is value required: no
  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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-wp-user

Invites your authenticated identity to a WordPress.com site as a non-admin user.

Usage

  • wpcom:create-site-wp-user [--role ROLE] [--dev] [--force-update] [--no-autocomplete] [--] [<site>]

This command sends a WordPress.com invitation to the email associated with your Team51 1Password account (OPSOASIS_WP_USERNAME). Inviting any other email is intentionally not supported. Roles are limited to contributor, author, or editor.

Arguments

site

The domain or numeric WPCOM ID of the site to invite yourself to.

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

Options

--role

The role to grant. One of: contributor, author, editor, administrator.

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

--dev

Run the CLI tool in developer mode.

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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:download-site-database

Download a SQL dump of the database from a WPCOM site.

Usage

  • wpcom:download-site-database [--destination DESTINATION] [--dev] [--force-update] [--no-autocomplete] [--] <site>

Use this command to export and download the database of a WPCOM site. The dump is gzipped on the server before transfer, and decompressed locally unless the destination ends in .gz.

Arguments

site

Domain or WPCOM site ID to download the database from.

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

Options

--destination

The destination path where the SQL dump will be saved. Ends in .gz to keep it compressed.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:download-site-plugins

Download plugins from a WPCOM site.

Usage

  • wpcom:download-site-plugins [--destination DESTINATION] [--dev] [--force-update] [--no-autocomplete] [--] <site>

Use this command to download all plugins from wp-content/plugins on a WPCOM site.

Arguments

site

Domain or WPCOM site ID to download plugins from.

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

Options

--destination

The destination path where the plugin archive will be saved.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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 and Site URLs of sites with a specific sticker.

Usage

  • wpcom:list-sites-with-sticker [--dev] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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-sftp-user-password

Rotates the SFTP/SSH user password on a WPCOM Atomic site.

Usage

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

This command rotates the SFTP/SSH user password on one or more WordPress.com Atomic sites. By default the site's primary SSH user is resolved automatically; use --user to override.

Arguments

site

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

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

Options

--user|-u

The SSH username to rotate the password for. Defaults to the site's primary SSH user.

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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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 concierge@wordpress.com.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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] [--force-update] [--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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:site:deployment:webhook:create

Creates a deployment webhook for a WordPress.com code deployment.

Usage

  • wpcom:site:deployment:webhook:create [--url URL] [--events EVENTS] [--sync-secret|--no-sync-secret] [--dev] [--force-update] [--no-autocomplete] [--] <site> [<deployment_id>]

Use this command to create a WPCOM code deployment webhook and persist its one-time secret to OpsOasis.

Arguments

site

Domain or WPCOM ID of the site.

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

deployment_id

The code deployment ID. If omitted, the command auto-selects from deployments for the site.

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

Options

--url

Webhook destination URL.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: 'https://opsoasis.wpspecialprojects.com/wp-json/wpcomsp/webhooks/v1/wpcom-deployments'

--events

Comma-separated webhook events to subscribe to.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Is negatable: no
  • Default: 'completed,failed,cancelled'

--sync-secret|--no-sync-secret

Persist the one-time webhook secret in OpsOasis immediately.

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

--dev

Run the CLI tool in developer mode.

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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:site:deployment:webhook:delete

Deletes a WordPress.com deployment webhook.

Usage

  • wpcom:site:deployment:webhook:delete [--dev] [--force-update] [--no-autocomplete] [--] <site> [<deployment_id> [<webhook_id>]]

Use this command to remove a deployment webhook from a WPCOM code deployment.

Arguments

site

Domain or WPCOM ID of the site.

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

deployment_id

The code deployment ID. If omitted, the command auto-selects from deployments for the site.

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

webhook_id

The webhook ID. If omitted, the command auto-selects from webhooks for the deployment.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:site:deployment:webhook:list

Lists deployment webhooks for a WordPress.com code deployment.

Usage

  • wpcom:site:deployment:webhook:list [--dev] [--force-update] [--no-autocomplete] [--] <site> [<deployment_id>]

Use this command to list webhooks configured for a WPCOM code deployment.

Arguments

site

Domain or WPCOM ID of the site.

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

deployment_id

The code deployment ID. If omitted, the command auto-selects from deployments for the site.

  • 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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:site:deployment:webhook:sync-secret

Syncs an existing WPCOM deployment webhook secret to OpsOasis.

Usage

  • wpcom:site:deployment:webhook:sync-secret [--dev] [--force-update] [--no-autocomplete] [--] <site> <deployment_id> <webhook_id> <secret>

Use this command to persist a webhook secret in OpsOasis when automatic sync fails or is skipped.

Arguments

site

Domain or WPCOM ID of the site.

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

deployment_id

The code deployment ID.

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

webhook_id

The webhook ID.

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

secret

The one-time webhook secret returned by WPCOM on 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

--force-update

Force update check regardless of when the last check was performed.

  • 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

--silent

Do not output any message

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

--quiet|-q

Only errors are displayed. All other output is suppressed

  • 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

Clone this wiki locally