homeport / dyff

δyƒƒ /ˈdʏf/ Description A diff tool for YAML files, and sometimes JSON. is inspired by the way the old BOSH v1 deployment output reported changes from one version to another by only showing the parts of a YAML file that change. Each difference is referenced by its location in the YAML document by using either the Spruce dot-style syntax ( ) or go-patch path syntax ( ). The output report aims to be as compact as possible to give a clear and simple overview of the change. Similar to the standard tool, it follows the principle of describing the change by going from the input file to the target input file. Input files can be local files (filesystem path), remote files (URI), or the standard input stream (using ). All orders of keys in hashes are preserved during processing and output to the terminal, most notably in the sub-commands to convert YAML to JSON and vice versa. Command documentation See command documentation for details about each command and its flags. Use cases and examples • Show differences between the live configuration of Kubernetes resources and what would be applied ( version >= ): The flag is required so that the exit code matches expectations. An exit code refers to no differences, in case differences are detected. Other exit codes are treated as program issues. _Note:_ Versions of older than did not split the environment variable into field, therefore you cannot use command arguments. In this case, you need to wrap the command with its argument into a helper shell script and use this instead. • Show the differences between two versions of YAMLs: • Embed into **Git** for better understandable differences • Convert a JSON stream to YAML • Sometimes you end up with YAML or JSON files, where the order of the keys in maps was sorted alphabetically. With you can restructure keys in maps to a more human appealing order: Or, rewrite a file _in place_ with the restructured order of keys. • Just print a YAML (or JSON) file to the terminal to look at it. By default, will use a neat output schema which includes different colors and indent helper lines to improve readability. The colors are roughly based on the default Atom schema and work best on dark terminal backgrounds. The neat output is disabled if the output of is redirected into a pipe, or you can disable it explicitly using the flag. • Convert a YAML file to JSON and vice versa: The sub-command ( , or ) defines the output format, the tool automatically detects the input format itself. Installation FreeBSD Install via ports: Install via package (pkg): Homebrew The has macOS and GNU/Linux pre-built binaries available: Mise Using mise you could do: MacPorts On macOS, is also available via MacPorts: Pre-built binaries in GitHub Prebuilt binaries can be downloaded from the GitHub Releases section. Curl To Shell Convenience Script There is a convenience script to download the latest release for Linux or macOS if you want to need it simple (you need and installed on your machine): Build from Source Starting with Go 1.17, you can install from source using : _Please note:_ This will install based on the latest available code base. Even though the goal is that the latest commit on the branch should always be a stable and usable version, this is not the recommended way to install and use . If you find an issue with this version, please make sure to note the commit SHA or date in the GitHub issue to indicate that it is not based on a released version. The version output will show for based builds. Contributing We are happy to have other people contributing to the project. If you decide to do that, here's how to: • get Go ( requires Go version 1.23 or greater) • fork the project • create a new branch • make your changes • open a PR. Git commit messages should be meaningful and follow the rules nicely written down by Chris Beams: > The seven rules of a great Git commit message > > 1. Separate subject from body with a blank line > 1. Limit the subject line to 50 characters > 1. Capitalize the subject line > 1. Do not end the subject line with a period > 1. Use the imperative mood in the subject line > 1. Wrap the body at 72 characters > 1. Use the body to explain what and why vs. how Running test cases and binaries generation Run test cases: Create binaries: License Licensed under MIT License