stephenc/envsub

envsub

$ envsub [options]

envsub是一个环境变量替换程序，与仅支持${NAME}格式的envsubst不同，它还支持${NAME-default}和${NAME:-default}等带默认值的替换格式。程序通过标准输入读取内容，逐行处理后输出到标准输出，应用所需的变量替换。

核心功能

• 支持多种环境变量替换格式：${NAME}、${NAME-default}、${NAME:-default}
• 可自定义替换模式的前缀和后缀，避免与现有内容冲突
• 启用贪婪默认值替换，未定义变量时自动替换为默认值
• 可指定仅替换特定变量，增强替换的精确性

使用场景

• 配置文件模板动态替换：将模板中的变量替换为实际环境变量值
• CI/CD流程：在构建或部署阶段注入环境变量到配置文件
• 动态生成配置：根据不同环境（开发、测试、生产）自动生成对应配置

命令行选项

• -h, --help：显示命令帮助信息并退出
• -p, --prefix：配置替换模式的替代前缀（默认值为${）
• -s, --suffix：配置替换模式的替代后缀（默认值为}）
• -g, --greedy-defaults：启用贪婪默认值替换，未定义变量时替换为默认值
• -v, --var：仅替换指定变量（可多次指定以替换多个变量）
• -V, --version：显示程序版本并退出

示例

基础用法

$ (echo 'FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}') | (unset FOO && envsub)
FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}
$ (echo 'FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}') | (unset FOO && envsub -v FOO)
FOO=${FOO} or unset or empty
$ (echo 'FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}') | (FOO= envsub)
FOO= or  or empty
$ (echo 'FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}') | (FOO= envsub -v BAR)
FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}
$ (echo 'FOO=${FOO} or ${FOO-unset} or ${FOO:-empty}') | (FOO=123 envsub)
FOO=123 or 123 or 123

自定义前缀和后缀

$ (echo 'FOO=%FOO:-empty%') | (FOO= envsub -p '%' -s '%')
FOO=empty