https://github.com/rgeraskin/godiffyaml
Human-readable diffs for yamls with multiple documents
https://github.com/rgeraskin/godiffyaml
diff k8s kubernetes yaml
Last synced: 10 months ago
JSON representation
Human-readable diffs for yamls with multiple documents
- Host: GitHub
- URL: https://github.com/rgeraskin/godiffyaml
- Owner: rgeraskin
- License: mit
- Created: 2025-05-03T18:58:28.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-05T23:27:01.000Z (about 1 year ago)
- Last Synced: 2025-05-07T19:13:05.800Z (about 1 year ago)
- Topics: diff, k8s, kubernetes, yaml
- Language: Go
- Homepage:
- Size: 423 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# godiffyaml
Human-readable diffs for yamls with multiple documents.
**godiffyaml** is a command-line tool for generating pretty diffs of YAML files, with special support for Kubernetes manifests and sorting YAML documents. It leverages [difftastic](https://github.com/Wilfred/difftastic) for visually rich and accurate diffs.
It can split multi-document YAML files into documents and diff them document-by-document using custom keys. This makes the diff to be human-readable and easier to understand.
Check out my blog post [here](https://blog.rgeraskin.dev/godiffyaml) for more details.
## Features
- **Diff YAML files**: Split multi-document YAML files and diff them document-by-document using custom keys.
- **Kubernetes-aware diff**: Diff Kubernetes manifests using `apiVersion`, `kind`, `metadata.namespace`, and `metadata.name` as document keys.
- **Sort YAML documents**: Output YAML files with documents sorted by specified fields.
- **Rich diff output**: Uses difftastic for side-by-side, inline, or JSON diff views.
## Installation
### Homebrew
```sh
brew install rgeraskin/homebrew/godiffyaml
```
### Go
[Difftastic](https://github.com/Wilfred/difftastic) is required to run `diff` and `k8s` subcommands.
```sh
go install github.com/rgeraskin/godiffyaml/cmd/godiffyaml@master
```
## Build from source
```sh
git clone https://github.com/rgeraskin/godiffyaml.git
cd godiffyaml
go build -o godiffyaml ./cmd/godiffyaml
```
## Usage
```
godiffyaml [options]
```
### Subcommands
#### `diff`
Diff two YAML files by splitting them into documents and comparing each document by custom keys.
```
godiffyaml diff --paths=key1,key2
```
- `--paths`: Comma-separated list of YAML paths to use as document keys (required).
- `--display`: Output format (`side-by-side`, `side-by-side-show-both`, `inline`, `json`). Default: `side-by-side-show-both`.
#### `k8s`
Diff two Kubernetes YAML files using `apiVersion,kind,metadata.namespace,metadata.name` as keys.
```
godiffyaml k8s
```
- `--display`: Output format (see above).
#### `sort`
Sort documents in a YAML file by specified fields and print to stdout.
```
godiffyaml sort --order=field1,field2
```
- `--order`: Comma-separated list of fields to sort by.
### Passing difftastic options
All unrecognized flags are passed directly to difftastic (except `--display`). Use `--flag=value` notation.
## Example
```sh
godiffyaml diff --paths=kind,metadata.name a.yaml b.yaml
godiffyaml k8s a.yaml b.yaml
godiffyaml sort --order=kind,metadata.name a.yaml
```