https://github.com/bandwidth/oas-linter-cli
A CLI tool to lint OpenAPI specifications with Bandwidth's custom spectral ruleset
https://github.com/bandwidth/oas-linter-cli
Last synced: about 2 months ago
JSON representation
A CLI tool to lint OpenAPI specifications with Bandwidth's custom spectral ruleset
- Host: GitHub
- URL: https://github.com/bandwidth/oas-linter-cli
- Owner: Bandwidth
- Created: 2022-07-20T15:21:29.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T15:17:34.000Z (3 months ago)
- Last Synced: 2025-03-26T00:11:24.125Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 509 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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](https://docs.stoplight.io/docs/spectral/e5b9616d6d50c-rulesets).
## Setup and Install
```sh
npm install -g @bandwidth/oas-linter-cli
```
## Usage
```sh
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
```sh
npm uninstall -g @bandwidth/oas-linter-cli
```