Add some docs on using env vars in place of CLI flags (open-policy-ag…

…ent#6631) Not sure where to put this really as we don't have much in terms of docs on the CLI outside of the generated ones. If there are more places where this could be mentioned, let me know and I'll add it there too. Signed-off-by: Anders Eknert <[email protected]> Signed-off-by: Thomas Sidebottom <[email protected]>
tsidebottom · Apr 17, 2024 · e619cde · e619cde
1 parent bde6179
commit e619cde
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/build/generate-cli-docs/generate.go b/build/generate-cli-docs/generate.go
@@ -21,7 +21,11 @@ weight: 90
 restrictedtoc: true
 ---
 
-The OPA executable provides the following commands.
+The OPA executable provides the following commands. Note that command line arguments may either be provided as
+traditional flags, or as environment variables. The expected format of environment variables used for this purpose
+follows the pattern OPA_<COMMAND>_<FLAG> where COMMAND is the command name in uppercase (like EVAL) and FLAG is the
+flag name in uppercase (like STRICT), i.e. OPA_EVAL_STRICT would be equivalent to passing the --strict flag to the
+eval command.
 
 `