json2yaml 5.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 .NET will choose which runtime to target.

You can use specific framework version if you want to run tool on different runtime:

dotnet tool install json2yaml --global --framework net6.0

This tool supports roll-forward Major behavior. It means it is possible to use tool not only with targeted runtimes, but with newer major ones as well.

Usage

Usage: json2yaml [options]

Options:
  -i|--input                 Path to json input file. E.g. `-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.
  --skip-content-type-check  Flag specifies if http response Content-Type header check can be skipped. Only in
                             effect when -u option is provided.
  -c|--console-output        Flag specifies if converted yaml should be printed directly to console. (In this
                             case -o option is ignorred.)
  -o|--output                Path to output yaml file. E.g. `-o:file.yaml (or -o="file.yaml")`. If omitted or
                             empty value provided ('-o') converter will output to file named like input file or
                             the last segment of url, but with .yaml extension. Required if input is read from
                             stdin.
  -m|--max-size              Specifies size limit for file to be converted. E.g. `-m:10`. If omitted, converter
                             will skip file larger that 20 MB. Respected only when used together with -i option.
  --format-null-as           Yaml can represent null in different ways. Supported values:
                             null|Null|NULL|~|empty. Default is "null".
  --json-framework           framework to use for json parser. Supported values: system|newtonsoft. Default is
                             "newtonsoft".
  --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

This will fetch json from provided endpoint and will write content to swagger.yaml file.

To change output file name use -o|--output option:

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

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

Format yaml output. Represent null as ~:

echo "[null, null]" | json2yaml -c --format-null-as:~

prints result:

- ~
- ~

Tool supports full piping scenarios:

cat swagger.json | json2yaml -c | grep version

Note

Since version 4.0.0 tool can use differnet json framework for json parsing (either Newtonsoft.Json or System.Text.Json) By default Newtonsoft.Json is used. This can be changed using --json-framework option.

json2yaml -i:input.json --json-framework:system