doc/cli.md in roger-1.6.4 vs doc/cli.md in roger-1.7.0

- old
+ new

@@ -50,6 +50,17 @@ ``` Options: -v, [--verbose] # Set's verbose output -h, [--help] # Help -``` +``` + +## Custom options + +All processors/middleware/etc. can use custom options. Roger will parse any leftover option that starts with `--` and sets it in the `project.options` hash. It even supports setting nested keys by using `:` as a separator. This means that `--release:rsync:disable=true` will become: `{release: { rsync: { disable: true}}}` in the options hash. + +### Parsing +The commandline parser will work with flags in the following formats: + +* `--key` will just set the flag to `true` +* `--key=value` and `--key value` will set the key `:key` to `"value"` +* `--key=true` and `--key=false` will convert to boolean `true` and `false` \ No newline at end of file