wp cli alias
Retrieves, sets and updates aliases for WordPress Installations.
$ wp cli alias
Aliases are shorthand references to WordPress installs. For instance,
@dev
could refer to a development install and @prod
could refer to a production install.
This command gives you and option to add, update and delete, the registered aliases you have available.
EXAMPLES
# List alias information.
$ wp cli alias list
list
---
@all: Run command against every registered alias.
@local:
user: wpcli
path: /Users/wpcli/sites/testsite
# Get alias information.
$ wp cli alias get @dev
ssh: dev@somedeve.env:12345/home/dev/
# Add alias.
$ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
Success: Added '@prod' alias.
# Update alias.
$ wp cli alias update @prod --set-user=newuser --set-path=/new/path/to/wordpress/install/
Success: Updated 'prod' alias.
# Delete alias.
$ wp cli alias delete @prod
Success: Deleted '@prod' alias.
GLOBAL PARAMETERS
--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", "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).
--[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.
Retrieves, sets and updates aliases for WordPress Installations.
Manages the internal WP-CLI cache,.
Checks to see if there is a newer version of WP-CLI available.
Dumps the list of installed commands, as JSON.
Generates tab completion strings.
Detects if a command exists
Prints various details about the WP-CLI environment.
Dumps the list of global parameters, as JSON or in var_export format.
Updates WP-CLI to the latest release.
Prints WP-CLI version.