https://github.com/sclevine/yj

CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.
https://github.com/sclevine/yj

cli convert converter go golang hcl json toml yaml

Last synced: about 7 hours ago
JSON representation

CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order.

• Host: GitHub
• URL: https://github.com/sclevine/yj
• Owner: sclevine
• License: apache-2.0
• Created: 2017-03-07T03:44:19.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-01-01T17:54:01.000Z (12 months ago)
• Last Synced: 2024-12-05T02:04:27.865Z (7 days ago)
• Topics: cli, convert, converter, go, golang, hcl, json, toml, yaml
• Language: Go
• Homepage:
• Size: 350 KB
• Stars: 975
• Watchers: 8
• Forks: 50
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - sclevine/yj - CLI - Convert between YAML, TOML, JSON, and HCL. Preserves map order. (json)

README

        


[![GoDoc](https://pkg.go.dev/badge/github.com/sclevine/yj/v5?status.svg)](https://pkg.go.dev/github.com/sclevine/yj/v5)

[![Tests](https://github.com/sclevine/yj/actions/workflows/go.yml/badge.svg)](https://github.com/sclevine/yj/actions/workflows/go.yml)

[![Packaging status](https://repology.org/badge/tiny-repos/yj-sclevine.svg)](https://repology.org/project/yj-sclevine/versions)

##

Convert between YAML, TOML, JSON, and HCL.

Preserves map order.

Format versions:

- YAML: **v1.2** (gopkg.in/yaml.v3)

- TOML: **v1.0.0** (github.com/BurntSushi/toml)

- JSON: **RFC 7159** (encoding/json)

- HCL: **v1** (github.com/hashicorp/hcl)

```

$ yj -h

Usage: yj [-][ytjcrneikhv]

Convert between YAML, TOML, JSON, and HCL.

Preserves map order.

-x[x]  Convert using stdin. Valid options:

          -yj, -y = YAML to JSON (default)

          -yy     = YAML to YAML

          -yt     = YAML to TOML

          -yc     = YAML to HCL

          -tj, -t = TOML to JSON

          -ty     = TOML to YAML

          -tt     = TOML to TOML

          -tc     = TOML to HCL

          -jj     = JSON to JSON

          -jy, -r = JSON to YAML

          -jt     = JSON to TOML

          -jc     = JSON to HCL

          -cy     = HCL to YAML

          -ct     = HCL to TOML

          -cj, -c = HCL to JSON

          -cc     = HCL to HCL

-n     Do not covert inf, -inf, and NaN to/from strings (YAML or TOML only)

-e     Escape HTML (JSON out only)

-i     Indent output (JSON or TOML out only)

-k     Attempt to parse keys as objects or numeric types (YAML out only)

-h     Show this help message

-v     Show version

```

## Installation

### Homebrew

The `yj` CLI is available via [Homebrew](https://brew.sh):

```bash

brew install yj

```

### Manual

Binaries for macOS, Linux, and Windows are [attached to each release](https://github.com/sclevine/yj/releases).

### Docker

`yj` is also available as a [Docker image](https://hub.docker.com/r/sclevine/yj).

## Go Package

Packages contained in this repo may also be used to convert all supported data formats to a normalized tree of ordered Go objects.

See [godoc](https://pkg.go.dev/github.com/sclevine/yj) for details.

NOTE: The current Go API should not be considered stable.