Dotenv commands for WP-CLI
NAME wp dotenv DESCRIPTION Manage a .env file SYNOPSIS wp dotenv <command> SUBCOMMANDS delete Delete a definition from the environment file get Get the value for a given key from the environment file init Initialize the environment file list List the defined variables from the environment file salts Manage WordPress salts in .env format set Set a value in the environment file for a given key.
dotenvcommands accept a
--file=<path>parameter to specify the location of the environment file.
If used, this parameter can be an absolute or relative path to the environment file, but which must include the file name (it does not have to be
Initializes a new environment file.
By default, this command will only create the environment file if it does not already exist, but it can do much more.
You may optionally initialize the environment file using another file as a template (eg:
.env.example, a common convention).
wp dotenv init --template=.env.example to use that file as the basis for the new environment file.
By default, the new file will be a copy of the template, but you may also set new values on the fly interactively!
--interactive flag with the same command will prompt for each defined variable in the template. You may specify a new value to use, or simply leave it blank to keep the template-defined value. Any other lines/comments from the template are preserved.
Initialize the new environment file with fresh salts provided by the wordpress.org salt generator service.
Any existing keys by the same name will not be overwritten. See
Overwrites an existing environment file, if it exists.
Prints out all of the key/value pairs as defined in the environment file.
You may also optionally limit the output to specific keys, or even keys that match simple patterns using glob pattern syntax.
wp dotenv list DB_* *AWS* would produce a list with the following hypotheical keys:
DB_NAME=... DB_PASS=... S3_AWS_ID=... S3_AWS_SECRET=...
list command supports all of the same options for
--format=<out> you've known to grow and love (
Get the value of a defined key from the environment file.
Set the value of a key in the environment file.
By default the value that is set is not quoted in the file. If you need your value to be quoted a certain way, you may optionally pass a flag for the preferred style of quote you want:
Remove one or more definitions for the given keys from the environment file.
Adds variable definitions to the environment file with fresh salts provided by the wordpress.org salt generator service.
By default, any existing keys by the same name will not be overwritten. However, if all of the defined salts in the environment file have the same value, then it is assumed that they are placeholders and will be updated. It is also possible to force regenerate them using
--force, or simply use the
regenerate command (see below).
generate, but will update all keys for salts with new values.
As of WP-CLI v0.23, you may install the dotenv command using the new
wp package install aaemnnosttv/wp-cli-dotenv-command:^2.0
For installation with prior versions of WP-CLI, see the wiki.
That's it! Now you should see the
dotenv command as an option when you run
wp from any directory.