Gathering detailed insights and metrics for @stoplight/spectral-cli
Gathering detailed insights and metrics for @stoplight/spectral-cli
A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI (v3.1, v3.0, and v2.0), Arazzo v1.0, as well as AsyncAPI v2.x.
Installations
npm install @stoplight/spectral-cliDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Min. Node Version
^16.20 || ^18.18 || >= 20.17
Node Version
22.14.0
NPM Version
8.19.4
Releases
107
Languages
5
TypeScript
JavaScript
HTML
Shell
Dockerfile
TypeScript (96.99%)
JavaScript (2.66%)
HTML (0.18%)
Shell (0.1%)
Dockerfile (0.07%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
Apache-2.0 License
2,775 Stars
2,126 Commits
259 Forks
33 Watchers
25 Branches
163 Contributors
Updated on Jul 16, 2025
Maintainers
2
Package Meta Information
Latest Version
6.15.0
Package Id
@stoplight/spectral-cli@6.15.0
Unpacked Size
64.60 kB
Size
19.49 kB
File Count
45
NPM Version
8.19.4
Node Version
22.14.0
Published on
Apr 22, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
19
@stoplight/json@stoplight/path@stoplight/spectral-core@stoplight/spectral-formatters@stoplight/spectral-parsers@stoplight/spectral-ref-resolver@stoplight/spectral-ruleset-bundler@stoplight/spectral-ruleset-migrator@stoplight/spectral-rulesets@stoplight/spectral-runtime@stoplight/typeschalkfast-globhpagentlodashpony-causestacktraceytslibyargs
- Custom Rulesets: Create custom rules to lint JSON or YAML objects
- Ready-to-use Rulesets: Validate and lint OpenAPI v2 & v3.x, AsyncAPI, and Arazzo v1 Documents
- JSON Path Support: Use JSON path to apply rules to specific parts of your objects
- Ready-to-use Functions: Built-in set of functions to help create custom rules. Functions include pattern checks, parameter checks, alphabetical ordering, a specified number of characters, provided keys are present in an object, etc.
- Custom Functions: Create custom functions for advanced use cases
- JSON Validation: Validate JSON with Ajv
Overview
🧰 Installation and Usage
Install
1npm install -g @stoplight/spectral-cli 2 3# OR 4 5yarn global add @stoplight/spectral-cli
Find more installation methods in our documentation.
Lint
1spectral lint petstore.yaml
📖 Documentation and Community
- Documentation
- Getting Started - The basics concepts, what Spectral is about.
- Using the Command-line Interface - Learn how the command line interface works.
- Continuous Integration - Spectral CLI can be run anywhere that NPM packages can be installed and run via CLI.
- Custom Rulesets - Don't like our rules? Throw 'em out and make your own.
- Custom Functions - When the core functions are not enough to solve a problem, you can write custom functions to do anything.
ℹ️ Support
If you need help using Spectral or have a support question, please use GitHub Discussions. It's also a great place to share your rulesets, or tools that leverage Spectral.
If you have a bug or feature request, please create an issue.
❓ FAQs
How is this different to Ajv
Ajv is a JSON Schema validator, and Spectral is a JSON/YAML linter. Instead of just validating against JSON Schema, it can be used to write rules for any sort of JSON/YAML object, which could be JSON Schema, or OpenAPI, or anything similar. Spectral does expose a schema function that you can use in your rules to validate all or part of the target object with JSON Schema (we even use Ajv used under the hood for this), but that's just one of many functions.
I want to lint my OpenAPI documents but don't want to implement Spectral right now.
No problem! A hosted version of Spectral comes free with the Stoplight platform. Sign up for a free account here.
What is the difference between Spectral and Speccy
Speccy was a great inspiration for Spectral, but was designed to work only with OpenAPI v3. Spectral can apply rules to any JSON/YAML object (including OpenAPI v2/v3, Arazzo, and AsyncAPI). Speccy has mostly been abandoned now, and is JavaScript not TypeScript.
⚙️ Integrations
- Stoplight Studio uses Spectral to validate and lint OpenAPI documents.
- Spectral GitHub Action, lints documents in your repo, built by Vincenzo Chianese.
- VS Code Spectral, all the power of Spectral without leaving VS Code.
🏁 Help Others Utilize Spectral
If you're using Spectral for an interesting use case, create an issue with details on how you're using it. We'll add it to a list here. Spread the goodness 🎉
👏 Contributing
If you are interested in contributing to Spectral, check out CONTRIBUTING.md.
🎉 Thanks
- Mike Ralphson for kicking off the Spectral CLI and his work on Speccy
- Jamund Ferguson for JUnit formatter
- Sindre Sorhus for Stylish formatter
- Ava Thorn for the Pretty formatter
- Julian Laval for HTML formatter
- @nulltoken for a whole bunch of amazing features
📜 License
Spectral is 100% free and open-source, under Apache License 2.0.
🌲 Sponsor Spectral by Planting a Tree
If you would like to thank us for creating Spectral, we ask that you buy the world a tree.
No vulnerabilities found.
Reason
9 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
no binaries found in the repo
Reason
Found 7/27 approved changesets -- score normalized to 2
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/jira-issue-label-added.yaml:1
- Warn: no topLevel permission defined: .github/workflows/markdown-links.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v6.15.0 not signed: https://api.github.com/repos/stoplightio/spectral/releases/213881708
- Warn: release artifact v6.14.3 not signed: https://api.github.com/repos/stoplightio/spectral/releases/203618541
- Warn: release artifact v6.14.2 not signed: https://api.github.com/repos/stoplightio/spectral/releases/186400741
- Warn: release artifact v6.14.1 not signed: https://api.github.com/repos/stoplightio/spectral/releases/185292905
- Warn: release artifact v6.14.0 not signed: https://api.github.com/repos/stoplightio/spectral/releases/184862357
- Warn: release artifact v6.15.0 does not have provenance: https://api.github.com/repos/stoplightio/spectral/releases/213881708
- Warn: release artifact v6.14.3 does not have provenance: https://api.github.com/repos/stoplightio/spectral/releases/203618541
- Warn: release artifact v6.14.2 does not have provenance: https://api.github.com/repos/stoplightio/spectral/releases/186400741
- Warn: release artifact v6.14.1 does not have provenance: https://api.github.com/repos/stoplightio/spectral/releases/185292905
- Warn: release artifact v6.14.0 does not have provenance: https://api.github.com/repos/stoplightio/spectral/releases/184862357
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/jira-issue-label-added.yaml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/stoplightio/spectral/jira-issue-label-added.yaml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/markdown-links.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/stoplightio/spectral/markdown-links.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/markdown-links.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/stoplightio/spectral/markdown-links.yml/develop?enable=pin
- Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:8: pin your Docker image by updating mcr.microsoft.com/vscode/devcontainers/javascript-node:0-12 to mcr.microsoft.com/vscode/devcontainers/javascript-node:0-12@sha256:badcf848a77adb3ad67c8111e1418f2baff2b241be99d17eba5cccc25dc4a2d7
- Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:16-alpine to node:16-alpine@sha256:a1f9d027912b58a7c75be7716c97cfbc6d3099f3a97ed84aa490be9dee20e787
- Info: 0 out of 1 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 11 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
- Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.6
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More