aaemnnosttv/wp-cli-dotenv-command

WP-CLI 的 Dotenv 命令

安装次数: 166,652

依赖者: 7

推荐者: 0

安全性: 0

星标: 170

关注者: 10

分支: 19

开放问题: 3

类型:wp-cli-package

v2.1.0 2021-06-05 19:21 UTC

This package is auto-updated.

Last update: 2024-09-07 06:40:16 UTC


README

Travis Build Packagist

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> 选项(tablejsoncsv 等)。默认: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 aaemnnosttv/wp-cli-dotenv-command:^2.0

对于WP-CLI旧版本的安装,请参阅维基百科

这就完成了!现在,当您从任何目录运行wp命令时,应该会看到dotenv命令作为选项之一。