json2yaml 1.1.0

json2yaml

A simple tool to convert json to yaml.

json2yaml converter reads json input (from file, url endpoint or stdin) and produces converted yaml output (to file or stdout).

Installation

dotnet tool install --global json2yaml

By default tool will install version targeting netcoreapp3.0.

Use specific framework version if you want tool to run on different runtime:

dotnet tool install json2yaml --global --framework netcoreapp2.1

Usage

Usage: json2yaml [options]

Options:
  -i|--input           Path to json input file. I.e. `-i:file.json` (or `-i="file.json"`). If empty value provided (`-i`), converter will search current directory for *.json file.
  -u|--url             HTTP endpoint to fetch json input from.
  -c|--console-output  [Optional]. Flag specifies if converted yaml should be printed directly to console. (In this case -o option is ignorred.)
  -o|--output          [Conditionally Optional]. Path to output yaml file. I.e. `-o:file.yaml (or -o="file.yaml")`. Optional only with -i or -c option. If omitted or empty value provided ('-o') converter will output to file named like input, but with .yaml extension.
  -m|--max-size        [Optional]. Specifies size limit for file to be converted. I.e. `-m:10`. If omitted, converter will skip file larger that 20 MB. Respected only when used together with -i option.
  --version            Shows tool version. If more options are provided this option is ignored.
  -v|--verbose         Verbose output. Shows more details on errors.
  -?|-h|--help         Show help information

Examples

The simplest use case to take input from file:

json2yaml -i

This will search current directory for json file. Convert its contents to yaml. And writes output to file named as input file, but with extension .yaml.

For remote input use this:

json2yaml -u:https://localhost:5001/swagger/v1/swagger.json -o:swagger.yaml

Note. For --url option either --output or flag --console-output is required.

To print conversion results directly to console use -c|--console-output flag:

json2yaml -i:input.json -c

Read input from stdin:

cat test.json | json2yaml -o:output.yaml

Tool supports full piping scenarios:

cat swagger.json | json2yaml -c | grep version