Skip to content

«Gendiff» is a CLI utility compares two configuration files and shows a difference.

Notifications You must be signed in to change notification settings

rmanzman/gendiff

Repository files navigation

Last commit GitHub Workflow Status Tests Maintainability Code Climate test coverage

Gendiff

Description:

Gendiff is a CLI utility compares two configuration files and shows a difference.

System requirements and Installation guide:

Make sure you have Node.js (14.0.x.x or higher) and npm installed.

  1. Clone the project
git clone https://github.com/rmanzman/gendiff.git
  1. Install the project
cd gendiff
npm ci
  1. Install dependencies
npm link

Usage

Usage: gendiff [options] <filepath1> <filepath2>

Compares two configuration files and shows a difference.

Options:
  -V, --version        output the version number
  -f, --format <type>  output format (default: "stylish")
  -h, --help           display help for command

Supported files and formats

Input formats: .json, .yaml, .yml.
Output formats: stylish, plain, JSON.

Usage examples and demonstration

For stylish output:

gendiff path/to/file1.json path/to/file2.json

or

gendiff -f stylish path/to/file1.json path/to/file2.json

Stylish output demonstration: asciicast


For plain output:

gendiff -f plain path/to/file1.json path/to/file2.json

Plain output demonstration: asciicast


For JSON output:

gendiff -f json path/to/file1.json path/to/file2.json

JSON output demonstration: asciicast

About

«Gendiff» is a CLI utility compares two configuration files and shows a difference.

Topics

Resources

Stars

Watchers

Forks