Skip to content
This repository was archived by the owner on Oct 16, 2024. It is now read-only.

team51 commands

Jump to bottom
Mike Straw edited this page Sep 11, 2023 · 9 revisions

Console Tool

deployhq:

pressable:

stats:

wpcom:

add-branch-protection-rules

Adds predefined branch protection rules to a given GitHub repository.

Usage

  • add-branch-protection-rules [-c|--contractor] [--dev] [--] <repo-slug>

Allows adding branch protection rules to a GitHub repository..

Arguments

repo-slug

Repository name in slug form (e.g. client-name)?

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

create-development-site

Creates a new development site (on Pressable).

Usage

  • create-development-site [--site-id SITE-ID] [--temporary-clone] [--label LABEL] [--skip-safety-net] [--branch BRANCH] [-c|--contractor] [--dev]

This command allows you to create a new development site.

Options

--site-id

The site ID of the production Pressable site you'd like to clone.

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

--temporary-clone

Creates a temporary clone of the production site for short-term development work. The site created is meant to be deleted after use.

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

--label

Used to name the Pressable instance. If not specified, time() will be used.

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

--skip-safety-net

Skips adding the Safety Net plugin to the development clone.

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

--branch

The GitHub branch you would like to the development site to use. Defaults to 'develop'.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

create-production-site

Creates a new production site (on Pressable).

Usage

  • create-production-site [--site-name SITE-NAME] [--connect-to-repo CONNECT-TO-REPO] [--zone-id ZONE-ID] [--template-id [TEMPLATE-ID]] [-c|--contractor] [--dev]

This command allows you to create a new production site.

Options

--site-name

This is root name that will be given to the site. Think of it as really the project name. No need to specify "prod" or "development" in the naming here. The script will take care of that for you -- no spaces, hyphens, non-alphanumeric characters, or capitalized letters.

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

--connect-to-repo

The repository you'd like to have automatically configured in DeployHQ to work with the new site. This accepts the repository slug. Only GitHub repositories are supported and they must be in the a8cteam51 organization, otherwise the script won't have access.

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

--zone-id

The datacenter zone to be setup on Pressable and DeployHQ. Can be EU or US. By default it's US Central. Additionally, you can use US-East or US-West

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

--template-id

The template that will be used while creating the project on DeployHQ. By default the DEPLOYHQ_DEFAULT_PROJECT_TEMPLATE config param is used.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

create-repository

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

Usage

  • create-repository [--repo-description REPO-DESCRIPTION] [--repo-type REPO-TYPE] [--site-production-url SITE-PRODUCTION-URL] [--site-development-url SITE-DEVELOPMENT-URL] [--site-php-long-prefix SITE-PHP-LONG-PREFIX] [--site-php-short-prefix SITE-PHP-SHORT-PREFIX] [--create-production-site] [--plugin-name] [--plugin-php-short-prefix PLUGIN-PHP-SHORT-PREFIX] [--issue-repo-only] [--production-url PRODUCTION-URL] [--development-url DEVELOPMENT-URL] [--custom-theme-slug CUSTOM-THEME-SLUG] [--custom-plugin-slug CUSTOM-PLUGIN-SLUG] [-c|--contractor] [--dev] [--] <repo-slug>

This command allows you to create a new Github repository.

Arguments

repo-slug

Repository name in slug form (e.g. client-name).

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

Options

--repo-description

A short, human-friendly description for this project.

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

--repo-type

The type of repository to create. One of either project, plugin, or issues.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Default: 'project'

--site-production-url

The hostname of the intended production site (do not include http/https, e.g. example.com).

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

--site-development-url

The hostname of the intended development site (do not include http/https, e.g. development-example.com).

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

--site-php-long-prefix

The long prefix for global PHP variables inside the project.

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

--site-php-short-prefix

The short prefix for global PHP variables inside the project.

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

--create-production-site

This script can optionally create a new Pressable production site and configure it in DeployHQ by passing --create-production-site.

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

--plugin-name

The name of the plugin.

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

--plugin-php-short-prefix

The short prefix for global PHP variables inside the plugin.

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

--issue-repo-only

Is this a repository to track project issues only with no associated code?

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

--production-url

The hostname of the intended production site (do not include http/https, e.g. example.com).

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

--development-url

The hostname of the intended development site (do not include http/https, e.g. development-example.com).

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

--custom-theme-slug

If this project involves us building a custom WordPress theme, pass the theme-slug with --custom-theme-slug=theme-slug.

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

--custom-plugin-slug

If this project involves us building a custom WordPress plugin, pass the plugin-slug with --custom-plugin-slug=plugin-slug.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

delete-branch-protection-rules

Delete branch protection rules for a given GitHub repository.

Usage

  • delete-branch-protection-rules [-c|--contractor] [--dev] [--] <repo-slug>

Allows deleting branch protection rules for a GitHub repository..

Arguments

repo-slug

Repository name in slug form (e.g. client-name)?

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

dump-commands

Dumps information about all commands

Usage

  • dump-commands [-f|--format FORMAT] [--save] [-d|--destination DESTINATION] [-c|--contractor] [--dev]

This command allows you to dump a list of all commands with their description and help. For more details on using this to update the CLI documentation, check here: https://github.com/Automattic/team51-cli/wiki

Arguments

command

The command to execute

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

Options

--format|-f

The format to use (md, txt, json, xml)

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

--save

Save the output to a file

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

--destination|-d

The path to save the output to (Only applies if --save option is set) If an extension isn't specified, it will be added automatically based on the format (e.g., 'dump-commands --format=json --destination=myfile' will output to myfile.json

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Default: '/Users/taco/code/team51-cli.wiki/team51-commands'

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

help

Display help for a command

Usage

  • help [--format FORMAT] [--raw] [-c|--contractor] [--dev] [--] [<command_name>]

The help command displays help for a given command:

php /usr/local/bin/team51 help list

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

php /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
  • Default: 'txt'

--raw

To output raw command help

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

jetpack-enable-sso

Activates Jetpack SSO module and enables two-factor authentication.

Usage

  • jetpack-enable-sso [-c|--contractor] [--dev] [--] <site-domain>

Use this command to enable the SSO module and two-factor authentication option in a single step. This command requires a Jetpack site connected to the a8cteam51 account.

Arguments

site-domain

The domain of the Jetpack connected site.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

jetpack-module

Enable/disable Jetpack modules for a site.

Usage

  • jetpack-module [-c|--contractor] [--dev] [--] <site-domain> <module> <setting>

Use this command to enable/disable Jetpack modules. This command requires a Jetpack site connected to the a8cteam51 account.

Arguments

site-domain

The domain of the Jetpack connected site.

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

module

The desired Jetpack module.

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

setting

enable/disable

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

jetpack-module-list

Shows status of Jetpack modules on a specified site.

Usage

  • jetpack-module-list [-c|--contractor] [--dev] [--] <site-domain>

Use this command to show a list of Jetpack modules on a site, and their status. This command requires a Jetpack site connected to the a8cteam51 account.

Arguments

site-domain

The domain of the Jetpack connected site.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

jetpack-sites-with

Searches Team 51 sites for a specified Jetpack module based on its status.

Usage

  • jetpack-sites-with [-c|--contractor] [--dev] [--] <module-slug> [<module-status>]

Use this command to find and show a list of sites where a particular Jetpack module is on or off. This command requires a Jetpack site connected to the a8cteam51 account. Usage Example: team51 jetpack-sites-with adwords on

Arguments

module-slug

The slug of the Jetpack module to search for.

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

module-status

The status of the Jetpack module to search for.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

list

List commands

Usage

  • list [--raw] [--format FORMAT] [-c|--contractor] [--dev] [--] [<namespace>]

The list command lists all commands:

php /usr/local/bin/team51 list

You can also display the commands for a specific namespace:

php /usr/local/bin/team51 list test

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

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

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

php /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
  • Default: false

--format

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

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

php-errors

Pulls the 3 most recent distinct fatal errors from the site's PHP error log.

Usage

  • php-errors [--format FORMAT] [--limit LIMIT] [--lines LINES] [-c|--contractor] [--dev] [--] <site>

Ex: team51 php-errors asia.si.edu --format raw --limit 10

Arguments

site

ID or URL of the site to retrieve the error log from.

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

Options

--format

The alternative format to output the logs in. Accepts either "table" or "raw".

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

--limit

The number of distinct PHP fatal errors to return. Default is 3.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Default: 3

--lines

The number of PHP error lines to retrieve. Default is 100k.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Default: 100000

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

plugin-list

Shows list of plugins on a specified site.

Usage

  • plugin-list [-c|--contractor] [--dev] [--] <site-domain>

Use this command to show a list of installed plugins on a site. This command requires a Jetpack site connected to the a8cteam51 account.

Arguments

site-domain

The domain of the Jetpack connected site.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

plugin-list-full-dump

Dumps a CSV of all plugins on on all t51 sites, including activation status

Usage

  • plugin-list-full-dump [-c|--contractor] [--dev]

Dumps a CSV of all plugins on on all t51 sites, including activation status

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

plugin-search

Search all Team51 WPCOM Jetpack sites for a specific plugin.

Usage

  • plugin-search [--partial] [-c|--contractor] [--dev] [--] <plugin-slug>

This command will output a list of Jetpack sites connected to the a8cteam51 account where a particular plugin is installed. The search can be made for an exact match plugin slug, or a general text search. Letter case is ignored in both search types. Example usage: plugin-search woocommerce plugin-search woo --partial

Arguments

plugin-slug

The slug of the plugin to search for. This is an exact match against the plugin installation folder name, the main plugin file name without the .php extension, and the Text Domain.

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

Options

--partial

Optional. Use for general text/partial match search. Using this option will also search the plugin Name field.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable-call-api

Calls the Pressable API directly

Usage

  • pressable-call-api [--query QUERY] [--method [METHOD]] [--data [DATA]] [--format [FORMAT]] [-c|--contractor] [--dev]

Refer to the API docs for more details: https://my.pressable.com/documentation/api/v1

Options

--query

The query string for the request. This is everything after "https://my.pressable.com/v1/" in URL. (e.g., "sites/1234"

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

--method

The query type (GET, POST, etc.). Default is GET.

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

--data

A JSON string of the data to pass on. (e.g.: {"paginate":true}

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

--format

The format of the response output (text, json). Default is json. "text" will dump using the print_r() function.

  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Default: 'json'

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable-grant-access

Grants user access to a Pressable site

Usage

  • pressable-grant-access [--email EMAIL] [--site [SITE]] [--search [SEARCH]] [-c|--contractor] [--dev]

Requires --email and --site. Grants access to a Pressable site, using site ID or site domain.

Options

--email

The user email.

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

--site

The Pressable site. Can be a numeric site ID or by domain.

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

--search

Search for any site by domain.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

remove-user

Removes a Pressable collaborator and WordPress user based on email.

Usage

  • remove-user [--email EMAIL] [--list] [-c|--contractor] [--dev]

This command allows you to bulk-delete from all sites a Pressable collaborator and WordPress user via CLI.

Options

--email

The email of the user you'd like to remove access from sites.

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

--list

List the sites where this email is found.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

site-list

Shows list of public facing sites managed by Team 51.

Usage

  • site-list [--audit [AUDIT]] [--exclude [EXCLUDE]] [-c|--contractor] [--dev] [--] [<export>]

Use this command to show a list of sites and summary counts managed by Team 51.

Arguments

export

Optional. Exports the results to a csv or json file saved in the team51-cli folder as sites.csv or sites.json. Example usage: site-list csv-export site-list json-export

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

Options

--audit

Optional. Produces a full list of sites, with reasons why they were or were not filtered. Currently works with the csv-export and --exclude options. 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. Example usage: site-list --audit='full' site-list --audit='no-staging' csv-export site-list --audit='is_private' csv-export --exclude='is_multisite'

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

--exclude

Optional. Exclude columns from the export option. Possible values: Site Name, Domain, Site ID, and Host. Letter case is not important. Example usage: site-list csv-export --exclude='Site name, Host' site-list json-export --exclude='site id,host'

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

triage

Generates a Digest Post of what upcoming Triage issues we have.

Usage

  • triage [-c|--contractor] [--dev]

Scans the triage column to find due dates in the near future.

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

update-repository-secret

Updates GitHub repository secret on github.com in the organization specified with GITHUB_API_OWNER. and project name

Usage

  • update-repository-secret [--secret-name SECRET-NAME] [--multiple MULTIPLE] [-c|--contractor] [--dev] [--] [<repo-slug>]

This command allows you to update Github repository secret or create one if it is missing.

Arguments

repo-slug

The slug of the GitHub repository

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

Options

--secret-name

Secret name in all caps (e.g., GH_BOT_TOKEN)

  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Default: 'GH_BOT_TOKEN'

--multiple

Determines whether the 'repo-slug' argument is optional or not. Accepts only 'all' currently.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

deployhq:rotate-private-key

Rotates private key in DeployHQ projects.

Usage

  • deployhq:rotate-private-key [-c|--contractor] [--dev]

This command allows you to rotate the private key in DeployHQ projects.

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

  • Accept value: no
  • Is value required: no
  • Is multiple: 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] [-c|--contractor] [--dev] [--] <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
  • Default: false

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable:generate-oauth-token

Generates a Pressable OAuth refresh token for a given API application.

Usage

  • pressable:generate-oauth-token [--client-id CLIENT-ID] [--client-secret CLIENT-SECRET] [-c|--contractor] [--dev]

This command requires a Pressable API application client ID and client secret, which it uses to generate a refresh token that outside collaborators can use to gain access to the Pressable API via this CLI tool.

Options

--client-id

The Pressable API application client ID.

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

--client-secret

The Pressable API application client secret.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable:open-site-shell

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

Usage

  • pressable:open-site-shell [-u|--user USER] [--shell-type SHELL-TYPE] [-c|--contractor] [--dev] [--] <site>

This command accepts a Pressable site as an input, then searches for the concierge user to generate the host argument. Lastly, it calls the system SSH/SFTP applications which will authenticate automatically via AutoProxxy. If the command is run in verbose mode, it will display the SSH user ID.

Arguments

site

ID or URL of the site to connect to.

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

Options

--user|-u

Email of the user to connect as. Defaults to your Team51 1Password email.

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

--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
  • Default: 'ssh'

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable:rotate-site-passwords

Rotates the SFTP user and WordPress user passwords of a given user on Pressable sites.

Usage

  • pressable:rotate-site-passwords [-u|--user USER] [--multiple MULTIPLE] [--dry-run] [-c|--contractor] [--dev] [--] [<site>]

This command calls the commands "pressable:rotate-site-sftp-user-password" and "pressable:rotate-site-wp-user-password", in this order, with the same arguments and options as provided to this command.

Arguments

site

ID or URL of the site for which to rotate the passwords.

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

Options

--user|-u

Email of the user for which to rotate the passwords. Default is concierge@wordpress.com.

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

--multiple

Determines whether the 'site' argument is optional or not. Accepts only 'related' currently.

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

--dry-run

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

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

  • Accept value: no
  • Is value required: no
  • Is multiple: 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] [-c|--contractor] [--dev] [--] [<site>]

This command allows you to rotate the SFTP password of users on Pressable sites. If the given user is also the website owner (default concierge@wordpress.com), then the DeployHQ configuration is also updated.

Arguments

site

ID or URL of the site for which to rotate the SFTP user password.

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

Options

--user|-u

ID, email, or username of the site SFTP user for which to rotate the password. Default is concierge@wordpress.com.

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

--multiple

Determines whether the 'site' argument is optional or not. Accepts only 'related' currently.

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

--dry-run

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

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

  • Accept value: no
  • Is value required: no
  • Is multiple: 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] [-c|--contractor] [--dev] [--] [<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

ID or URL of the site for which to rotate the WP user password.

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

Options

--user|-u

Email of the site WP user for which to rotate the password. Default is concierge@wordpress.com.

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

--multiple

Determines whether the 'site' argument is optional or not. Accepts only 'related' currently.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: 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
  • Default: false

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

  • Accept value: no
  • Is value required: no
  • Is multiple: 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 [-c|--contractor] [--dev] [--] <site> <wp-cli-command>

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

Arguments

site

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

  • 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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

pressable:upload-site-icon

Uploads the site icon as apple-touch-icon.png on a Pressable site.

Usage

  • pressable:upload-site-icon [--dry-run] [-c|--contractor] [--dev] [--] <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

--dry-run

Execute a dry run. It will output all the steps, but will not upload the icon.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

stats:woocommerce-orders

Get WooCommerce order stats across all Team51 sites.

Usage

  • stats:woocommerce-orders [--unit UNIT] [--date DATE] [--check-production-sites] [--csv] [-c|--contractor] [--dev]

This command will output the top grossing WooCommerce sites we support with dollar amounts and an over amount summed across all of our sites. Example usage: stats:woocommerce-orders --unit=year --date=2022 stats:woocommerce-orders --unit=week --date=2022-W12 stats:woocommerce-orders --unit=month --date=2021-10 stats:woocommerce-orders --unit=day --date=2022-02-27

Options

--unit

Options: day, week, month, year.

  • Accept value: yes
  • Is value required: yes
  • Is multiple: 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
  • Default: NULL

--check-production-sites

Checks production sites instead of the Jetpack Profile for the sites. Takes much longer to run. You might want to check the production sites if you suspect that the Jetpack cache isn't up to date for your purposes and a newly connected site with lots of sales has WooCommerce installed.

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

--csv

Export stats to a CSV file.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

stats:wpcom-traffic

Get wpcom traffic across all Team51 sites.

Usage

  • stats:wpcom-traffic [--num [NUM]] [--period PERIOD] [--date DATE] [--csv] [-c|--contractor] [--dev]

This command will output a summary of wpcom traffic stats across all of our sites. Example usage: stats:wpcom-traffic --period=year --date=2022-12-12 stats:wpcom-traffic --num=3 --period=week --date=2021-10-25 stats:wpcom-traffic --num=6 --period=month --date=2021-02-28 stats:wpcom-traffic --period=day --date=2022-02-27

The stats come from: https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/stats/summary/

Options

--num

Number of periods to include in the results Default: 1.

  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Default: 1

--period

Options: day, week, month, year. day: The output will return results over the past [num] days, the last day being the date specified. week: The output will return results over the past [num] weeks, the last week being the week containing the date specified. month: The output will return results over the past [num] months, the last month being the month containing the date specified. year: The output will return results over the past [num] years, the last year being the year containing the date specified.

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

--date

Date format: YYYY-MM-DD.

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

--csv

Export stats to a CSV file.

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

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

wpcom:add-sticker

Add the specified sticker to the site.

Usage

  • wpcom:add-sticker [-c|--contractor] [--dev] [--] <site> <sticker>

This command allows you add a blog sticker to a site given a site ID or URL.

Arguments

site

ID or URL of the site to add a sticker.

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

sticker

Sticker to add to the site.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

wpcom:get-stickers

Get a list of a site's stickers.

Usage

  • wpcom:get-stickers [-c|--contractor] [--dev] [--] <site>

This command allows you get a list of stickers associated with a site given a site ID or URL.

Arguments

site

ID or URL of the site for which get stickers associated.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

wpcom:remove-sticker

Remove the specified sticker on the site.

Usage

  • wpcom:remove-sticker [-c|--contractor] [--dev] [--] <site> <sticker>

This command allows you remove a sticker to a site given a site ID or URL.

Arguments

site

ID or URL of the site to remove a sticker.

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

sticker

Sticker to remove.

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

Options

--contractor|-c

Use the contractor config file.

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

--dev

Run the CLI tool in developer mode.

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

--help|-h

Display this help message

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

--quiet|-q

Do not output any message

  • Accept value: no
  • Is value required: no
  • Is multiple: 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
  • Default: false

--version|-V

Display this application version

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

--ansi

Force ANSI output

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

--no-ansi

Disable ANSI output

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

--no-interaction|-n

Do not ask any interactive question

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

Clone this wiki locally