salty-dog/README.md

# SALTY DOG

JSON **s**chema **a**nalysis, **l**inting, and **t**ransformation for **Y**AML, featuring **d**efaults, **o**ptional
fields, and other **g**ood stuff.

- [SALTY DOG](#salty-dog)
  - [Build](#build)
  - [Usage](#usage)
    - [Options](#options)
      - [Count](#count)
      - [Exclude Level](#exclude-level)
      - [Exclude Name](#exclude-name)
      - [Exclude Tag](#exclude-tag)
      - [Include Level](#include-level)
      - [Include Name](#include-name)
      - [Include Tag](#include-tag)
      - [Mode](#mode)
      - [Rules](#rules)
      - [Source](#source)

## Build

```shell
> git clone git@github.com:ssube/salty-dog.git
> make
```

## Usage

```shell
> cat rules/examples/kubernetes-require-resources-fail.yml |\
    salty-dog \
      --rules rules/kubernetes.yml \
      --source - \
      --tag important |\
    ./node_modules/.bin/bunyan

[2019-06-15T23:56:04.764Z] ERROR: salty-dog/22211 on cerberus: some rules failed (errors=1)

> cat rules/examples/kubernetes-require-resources-pass.yml |\
    salty-dog \
      --rules rules/kubernetes.yml \
      --source - \
      --tag important |\
    ./node_modules/.bin/bunyan

[2019-06-15T23:53:34.223Z]  INFO: salty-dog/19839 on cerberus: all rules passed
```

### Options

Excludes take priority over includes: a rule matching some of both will be excluded.

#### Count

- Alias: `c`

Exit with the error count (max of 255) rather than `0` or `1`.

#### Exclude Level

Exclude rules by log level.

#### Exclude Name

Exclude rules by name.

#### Exclude Tag

Exclude rules by tag.

#### Include Level

Include rules by log level.

#### Include Name

Include rules by name.

#### Include Tag

- Alias: `t`, `tag`

Include rules by tag.

#### Mode

- Alias: `m`
- Default: `check`
  
The application mode.

Options:

- `check` runs each rule and exits with an indicative status
- `clean` runs each rule and updates the source data with any defaults or other changes before running the next rule

#### Rules

The path to a file containing some `rules`.

#### Source

- Alias: `s`
- Default: `-`

The source file to validate.

Defaults to stdin (`-`) to work with pipes: `cat file.yml | salty --source -`