Skip to content

CLI tool for publishing and validating contracts using judge-d API.

License

Notifications You must be signed in to change notification settings

HLTech/judge-d-js

Repository files navigation

Judge-d

Judge-d is a JS CLI tool for publishing and validating contracts using judge-d API.

Install

$ npm i judge-d -g

Usage

$ judge-d --help

Help output:

Commands:
  judge-d publish  Publish contracts
  judge-d verify   Verify contracts

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Commands

$ judge-d publish --help
Publish contracts

Options:
  --url             Url to judge-d instance                  [string] [required]
  --serviceName     Service name                             [string] [required]
  --serviceVersion  Service version                          [string] [required]

  Required one of:
  --pactsDir        Path to directory with pacts             [string]
  --swaggerFile     Path to swagger json file                [string]

$ judge-d verify --help
It verifies contracts and generates HTML report if outFile is provided

Options:
  --url             Url to judge-d instance                  [string] [required]
  --serviceName     Service name                             [string] [required]
  --serviceVersion  Service version                          [string] [required]
  --environment     Environment name                         [string] [required]
  --outFile         Path with HTML report filename, ex. report.html     [string]