Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.76 KB

README.md

File metadata and controls

50 lines (38 loc) · 1.76 KB

OpenSSF Scorecard CodeQL Go Report Card Tests Passing

schemacheck

A CLI utility written in go that validates json and yaml files against a schema.

Usage

schemacheck is meant to be used against one schema and one or more yaml or json files.

After installation, you can run it like:

schemacheck --schema myschema.json --file myjson.json --file myyaml.yaml .......

You can get the usage at any time by running:

schemacheck --help

You can also call this CLI from other command line utililties like find.

find . -type f -name "*.json" -exec ./dist/bin/schemacheck -s test_data/schema.json -f {} \+

Install

There are a couple different methods to install schemacheck.

Preferred methods

  • Via go (recommended): go install github.com/adrielp/schemacheck
  • Via brew: brew install adrielp/tap/schemacheck (Mac / Linux)

Mac/Linux during local development

  • Clone down this repository and run make install

Windows

There's a binary for that, but it's not directly supported or tested because #windows

Getting Started

Prereqs

Instructions

  • Clone down this repository
  • Run commands in the Makefile like make build