https://github.com/hltech/judge-d-js
CLI tool for publishing and validating contracts using judge-d API.
https://github.com/hltech/judge-d-js
Last synced: 8 months ago
JSON representation
CLI tool for publishing and validating contracts using judge-d API.
- Host: GitHub
- URL: https://github.com/hltech/judge-d-js
- Owner: HLTech
- License: mit
- Created: 2021-03-02T11:46:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-30T09:18:40.000Z (about 4 years ago)
- Last Synced: 2025-02-01T02:04:07.042Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 359 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Judge-d
Judge-d is a JS CLI tool for publishing and validating contracts using [judge-d](https://github.com/HLTech/judge-d) API.
## Install
```sh
$ npm i judge-d -g
```
## Usage
```sh
$ 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
```sh
$ 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]
```
```sh
$ 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]
```