From afafdddcf0ee298a435a9faa20ef1cf3edacc0b8 Mon Sep 17 00:00:00 2001 From: ssube Date: Thu, 4 Jul 2019 09:49:53 -0500 Subject: [PATCH] docs: mode command changes --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b57a497..b21cc65 100644 --- a/README.md +++ b/README.md @@ -192,10 +192,17 @@ The `--source` and `--dest` default to stdin and stdout, respectively, but a pat #### Fix Mode -`salty-dog` can also add default values to missing properties with `--mode fix`. If a rule does not immediately pass +`salty-dog` can also add default values to missing properties in `fix` mode. If a rule does not immediately pass with the `--source` document, but defaults are provided in the schema, the defaults will be inserted before printing to `--dest`. +```shell +> salty-dog fix \ + --source examples/kubernetes-resources-some.yml \ + --rules rules/kubernetes.yml \ + --tag kubernetes +``` + ##### Default Values Properties that appear in the schema with a `default` provided will be added to each element as it is checked. Rules @@ -209,13 +216,13 @@ is documented by Ajv. #### List Mode -`salty-dog` can list the active set of rules, to help debug tags and inclusion. +`salty-dog` can list the active set of rules, to help debug tags and inclusion. Both `--source` and `--dest` are +ignored in `list` mode. ```shell -> salty-dog \ +> salty-dog list \ --rules rules/kubernetes.yml \ - --tag kubernetes \ - --mode list + --tag kubernetes ... [2019-06-30T18:39:11.930Z] INFO: salty-dog/26330 on cerberus: listing active rules