diff --git a/pkg/yqlib/doc/Env Variable Operators.md b/pkg/yqlib/doc/Env Variable Operators.md index c166f3ef..c9923c68 100644 --- a/pkg/yqlib/doc/Env Variable Operators.md +++ b/pkg/yqlib/doc/Env Variable Operators.md @@ -1,3 +1,5 @@ +This operator is used to handle environment variables usage in path expressions. While environment variables can, of course, be passed in via your CLI with string interpolation, this often comes with complex quote escaping and can be tricky to write and read. Note that there are two forms, `env` which will parse the environment variable as a yaml (be it a map, array, string, number of boolean) and `strenv` which will always parse the argument as a string. + ## Read string environment variable Running diff --git a/pkg/yqlib/doc/headers/Env Variable Operators.md b/pkg/yqlib/doc/headers/Env Variable Operators.md index e69de29b..d18e72fc 100644 --- a/pkg/yqlib/doc/headers/Env Variable Operators.md +++ b/pkg/yqlib/doc/headers/Env Variable Operators.md @@ -0,0 +1,2 @@ +This operator is used to handle environment variables usage in path expressions. While environment variables can, of course, be passed in via your CLI with string interpolation, this often comes with complex quote escaping and can be tricky to write and read. Note that there are two forms, `env` which will parse the environment variable as a yaml (be it a map, array, string, number of boolean) and `strenv` which will always parse the argument as a string. +