yuloh/json-guard-cli

A CLI tool for json-guard

json-guard-cli

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

This package is a CLI client for JSON Guard, a JSON Schema validator. You can easily validate data against a schema or check your schema itself., _(*2)

, _(*3)

Install

Installation uses Composer., _(*4)

Project Install

``` bash $ composer require yuloh/json-guard-cli, <sub>(*5)</sub>

### Global Install

If you don't want to install this per project, you can install it globally and use it anywhere.  If you aren't familiar with Composer's global install functionality, [this tutorial should get you up and running](https://akrabat.com/global-installation-of-php-tools-with-composer/).

```bash
$ composer global require yuloh/json-guard-cli

Usage

Validate

Validate Data Against a Schema., <sub>(*6)</sub>

Usage:, <sub>(*7)</sub>

$ json-guard validate [<data>] [<schema>]

Arguments:, <sub>(*8)</sub>

• data: The data to validate.
• schema: The schema to use.

Examples:, <sub>(*9)</sub>

# Using files
$ json-guard validate my-data.json my-schema.json
# Using JSON strings
$ json-guard validate \
'{ "id": "https://json-guard.dev/schema#" }' \
'{ "properties": { "id": { "type": "string", "format": "uri" } } }'
# Loading Schema with a Loader
$ json-guard validate my-data.json 'http://json-schema.org/draft-04/schema#'

Check

Check that a JSON Schema is valid., <sub>(*10)</sub>

Usage:, <sub>(*11)</sub>

$ json-guard check [<schema>]

Arguments:, <sub>(*12)</sub>

• schema: The schema to check.

Examples:, <sub>(*13)</sub>

$ json-guard check my-schema.json

Loading JSON

All commands can load the JSON as a string, from a loader path, from a local file path, or from STDIN., <sub>(*14)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*15)</sub>

Testing

bash $ composer test, <sub>(*16)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*17)</sub>

Credits

• Matt Allan
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*18)</sub>