WP-CLI

WP-CLI is the official command-line tool for WordPress

Type object
File match wp-cli.local.yml wp-cli.yml **/.wp-cli/config.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/wp-cli/latest.json
Source https://raw.githubusercontent.com/wp-cli/wp-cli/refs/heads/main/schemas/wp-cli-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON Schema for validating wp-cli.yml configuration files

Properties

$schema string

JSON Schema reference

path string

Path to the WordPress files.

Default: null
ssh string

Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant").

Default: null
http string

Perform operation against a remote WordPress installation over HTTP.

Default: null
format=uri
url string

Pretend request came from given URL. In multisite, this argument is how the target site is specified.

Default: null
format=uri
user string

Set the WordPress user.

Default: null
skip-plugins string[]

Skip loading all or some plugins. Note: mu-plugins are still loaded.

Default:
[]
skip-themes string[]

Skip loading all or some themes.

Default:
[]
skip-packages boolean

Skip loading all installed packages.

Default: false
require string[]

Load PHP file before running the command (may be used more than once).

Default:
[]
exec string[]

Execute PHP code before running the command (may be used more than once).

Default:
[]
context string

Load WordPress in a given context.

Default: "auto"
One of: const: "admin" const: "admin", const: "auto" const: "auto", const: "cli" const: "cli", const: "frontend" const: "frontend"
disabled_commands string[]

(Sub)commands to disable.

Default:
[]
color boolean | string

Whether to colorize the output.

Default: "auto"
debug boolean | string

Show all PHP errors; add verbosity to WP-CLI bootstrap.

Default: false
quiet boolean

Suppress informational messages.

Default: false
apache_modules string[]

List of Apache Modules that are to be reported as loaded.

Default:
[]
env Record<string, string | number>

Set environment variable values. These will be used as fallbacks when the corresponding environment variable is not set in the shell. All values are converted to strings.

Default:
{}
_ object

'_' is a special value denoting configuration options for this wp-cli.yml

2 nested properties
merge boolean

Merge subcommand defaults from the upstream config.yml, instead of overriding

Default: false
inherit string

Inherit configuration from an arbitrary YAML file

Default: null