Skip to content

A CLI tool to lint OpenAPI specifications with Bandwidth's custom spectral ruleset

Notifications You must be signed in to change notification settings

Bandwidth/oas-linter-cli

Repository files navigation

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

About

A CLI tool to lint OpenAPI specifications with Bandwidth's custom spectral ruleset

Resources

Stars

Watchers

Forks

Packages

No packages published