wp db cli

Opens a MySQL console using credentials from wp-config.php

In this article

This command runs on the after_wp_config_load hook, after wp-config.php has been loaded into scope.

Options

[--database=<database>]
Use a specific database. Defaults to DB_NAME.
[--default-character-set=<character-set>]
Use a specific character set. Defaults to DB_CHARSET when defined.
[--dbuser=<value>]
Username to pass to mysql. Defaults to DB_USER.
[--dbpass=<value>]
Password to pass to mysql. Defaults to DB_PASSWORD.
[--<field>=<value>]
Extra arguments to pass to mysql. Refer to mysql docs.
[--defaults]
Loads the environment’s MySQL option files. Default behavior is to skip loading them to avoid failures due to misconfiguration.

Examples

# Open MySQL console
$ wp db cli
mysql&gt;

Global Parameters

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

Command documentation is regenerated at every release. To add or update an example, please submit a pull request against the corresponding part of the codebase.