Skip to content

The missing CLI for the JSON Schema $Ref Parser

Notifications You must be signed in to change notification settings

skriptfabrik/json-schema-bundler

Repository files navigation

JSON Schema Bundler

NPM Version NPM Downloads Continuous Integration

The missing CLI for the JSON Schema $Ref Parser

Installation

Install using npm as global package:

npm install -g @skriptfabrik/json-schema-bundler

Usage

json-schema-bundler --help
JSON Schema Bundler

Usage:
  json-schema-bundler [options] <input>

Arguments:
  input  The path of the input schema file

Options:
  -d, --dereference  Replacing each reference with its resolved value
  -h, --help         Display this help message
  -p, --pretty       Pretty print output
  -s, --silent       Silent mode
  -v, --version      Print version number
  -y, --yaml         Output as YAML document instead of JSON

Examples:
  Bundle all references in schema.json with internal $ref pointers and print output to stdout:

    json-schema-bundler schema.json

  Dereference all references in schema.json and print output to stdout:

    json-schema-bundler -d schema.json

Docker

Use the following command to bundle all references in schema.json and print the output to stdout:

docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler schema.json

To dereference all references in schema.json and print the output to stdout add the -d option:

docker run --rm -v `pwd`:/work -w /work skriptfabrik/json-schema-bundler -d schema.json