Skip to content

Commit

Permalink
Add some docs on using env vars in place of CLI flags (#6631)
Browse files Browse the repository at this point in the history
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 <anders@styra.com>
  • Loading branch information
anderseknert authored Mar 15, 2024
1 parent 1a1ff2b commit 92a4d1f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion build/generate-cli-docs/generate.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`

Expand Down

0 comments on commit 92a4d1f

Please sign in to comment.