From 143a0523a8cc8a7aa3839e1bb95699392d1afd2f Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Wed, 3 Oct 2018 23:25:02 +0200 Subject: [PATCH] Add docs for sub-commands with arguments closes #1 Signed-off-by: Knut Ahlers --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f023769..7973483 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,22 @@ In general this program can either output your ENV variables to use with `eval` or similar or it can run a program with populated environment. -``` -# vault2env --key= +```console +$ vault2env --key= -# vault2env --export --key= +$ vault2env --export --key= export ... ``` +In case you have a command with arguments you need to separate the command using double dashes, which is a feature of your shell: + +```console +$ vault2env --key= -- +``` + +This prevents `vault2env` from interpreting and complaining about the arguments passed to the sub-command. + ### Using evironment variables ```bash # export VAULT_ADDR="https://127.0.0.1:8200"