WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp cli alias add

wp cli alias add

Creates an alias.

In this article

Back to top

GitHub
View Open Issues (0) View Closed Issues (0) Create New Issue
This command runs on the before_wp_load hook, just before the WP load process begins.

Options

<key>
Key for the alias.
[--set-user=<user>]
Set user for alias.
[--set-url=<url>]
Set url for alias.
[--set-path=<path>]
Set path for alias.
[--set-ssh=<ssh>]
Set ssh for alias.
[--set-http=<http>]
Set http for alias.
[--grouping=<grouping>]
For grouping multiple aliases.
[--config=<config>]
Config file to be considered for operations.
—
default: global
options:
– global
– project
—

Examples

# Add alias to global config.
$ wp cli alias add @prod  --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
Success: Added '@prod' alias.

# Add alias to project config.
$ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli --config=project
Success: Added '@prod' alias.

# Add group of aliases.
$ wp cli alias add @multiservers --grouping=servera,serverb
Success: Added '@multiservers' alias.

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.