README.md

Codefresh YAML Validator

An NPM module/CLI for validating the Codefresh YAML.

Developed in Codefresh.

Installation

$ npm install @codefresh-io/yaml-validator -g

Usage

Command Line Interface

# Search for a file named codefresh.yml in the current working directory and validate it
cyv validate

# Validate the specified codefresh.yml file
cyv validate --file /path/to/codefresh.yml 

NPM Module

const cyv  = require('@codefresh-io/yaml-validator');
const yaml = require('js-yaml');
const fs   = require('fs');

const doc = yaml.safeLoad(fs.readFileSync('/path/to/codefresh.yml', 'utf8'));
cyv(doc);

License

Copyright © 2016, Codefresh. Released under the MIT license.

---