Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 726 Bytes

README.md

File metadata and controls

34 lines (23 loc) · 726 Bytes

oas-linter-cli

This is a CLI tool that enables users to run an OAS (Open API Spec) file through Bandwidth's custom Stoplight ruleset.

Setup and Install

npm install -g @bandwidth/oas-linter-cli

Usage

bw-oas-linter lint ../path/to/my/spec.yml    # json also supported

Options

Run bw-oas-linter lint -h for a list of options.

Flag Description
-s Save linter result to users home directory
-j Output JSON
-r Path to custom spectral ruleset file
-h Print help menu
-v Print package version

Uninstall

npm uninstall -g @bandwidth/oas-linter-cli