Skip to content

Commit

Permalink
#55 Update documentation about follow key in the commands config file
Browse files Browse the repository at this point in the history
  • Loading branch information
zshamrock committed May 4, 2018
1 parent c965f11 commit f503244
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,18 @@ There are 2 available commands: `list` and `run`.
[command-name]
workingdir=
command=
follow=
```

where `command-name` is the command name which will be used in the `run` command, i.e. `vmx run host-name command-name`.

`workingdir` is optional, i.e. you can provide the working dir to change before running the command.

`follow` is also the optional key, boolean value is expected there, like 1|0, true|false, yes|no, which has the same
meaning as `--follow` CLI argument, i.e. follows the output of the command execution. The purpose of this key is to
define the "follow" flag as part of the command definition in the file and not specify it very time over `--profile`
when command is run.

`command` is the required field.

Ex.:
Expand Down

0 comments on commit f503244

Please sign in to comment.