amphibee / wp-cli-dotenv-command
WP-CLI的Dotenv命令
Requires
- php: ^8.0|^8.1
Requires (Dev)
- phpunit/phpunit: ^9|^10
- wp-cli/wp-cli-tests: ^3.2
README
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.
所有
dotenv
命令都接受一个--file=<path>
参数来指定环境文件的路径。
默认为.env
。
如果使用,此参数可以是绝对或相对路径,但必须包括文件名(不一定是.env
)。
init
初始化一个新的环境文件。
默认情况下,此命令将仅在没有现有环境文件时创建环境文件,但它可以做更多。
--template=<file>
您可以使用其他文件作为模板(例如:.env.example
,这是一个常见的约定)来初始化环境文件。运行wp dotenv init --template=.env.example
以使用该文件作为新环境文件的基础。
默认情况下,新文件将是模板的副本,但您也可以在交互式地设置新值!使用与同一命令相同的--interactive
标志将提示模板中定义的每个变量。您可以指定要使用的新值,或者简单地留空以保留模板定义的值。模板中的任何其他行/注释都将保留。
--with-salts
使用由wordpress.org盐生成服务提供的全新盐初始化新的环境文件。同名现有密钥不会被覆盖。查看salts
。
--force
如果存在,将覆盖现有的环境文件。
list [<pattern>...]
打印出环境文件中定义的所有键/值对。
您还可以选择限制输出到特定键,甚至使用glob模式语法匹配简单模式的键。例如:wp dotenv list DB_* *AWS*
将生成以下假设键的列表
DB_NAME=...
DB_PASS=...
S3_AWS_ID=...
S3_AWS_SECRET=...
list
命令支持所有您熟悉的--format=<out>
选项(table
、json
、csv
等)。默认:table
。
get <key>
从环境文件中获取定义的键的值。
set <key> <value>
设置环境文件中键的值。
默认情况下,设置的值在文件中未加引号。如果您需要以某种方式加引号,您可以可选地传递一个标志来指定您想要的引号风格:--quote-single
或--quote-double
。
delete <key>...
从环境文件中删除给定键的一个或多个定义。
salts
generate
通过wordpress.org盐生成服务将变量定义添加到环境文件中。
默认情况下,同名现有密钥不会被覆盖。但是,如果环境文件中定义的所有盐具有相同的值,则假定它们是占位符并将被更新。您还可以使用--force
强制重新生成它们,或者简单地使用regenerate
命令(见下文)。
regenerate
与generate
相同,但将更新所有盐密钥的新值。
安装
推荐
从WP-CLI v0.23开始,您可以使用新的package
命令安装dotenv命令。
wp package install amphibee/wp-cli-dotenv-command:^2.0
对于与旧版本WP-CLI的安装,请参阅维基页面。
这就完成了!现在您应该在从任何目录运行wp
命令时看到dotenv命令作为选项。