Skip to content


GitHub stars GitHub release (latest SemVer) GitHub last commit GitHub commit activity GitHub contributors

spectral documentation

spectral - GitHub

Configuration in MegaLinter

Variable Description Default value
OPENAPI_SPECTRAL_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
Ex: (src\|lib)
Include every file
Ex: (test\|examples)
Exclude no file
OPENAPI_SPECTRAL_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- project: Call the linter from the root of the project
OPENAPI_SPECTRAL_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".yml", ".yaml", ".json"]
OPENAPI_SPECTRAL_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
OPENAPI_SPECTRAL_PRE_COMMANDS List of bash commands to run before the linter None
OPENAPI_SPECTRAL_POST_COMMANDS List of bash commands to run after the linter None
OPENAPI_SPECTRAL_CONFIG_FILE spectral configuration file nameUse LINTER_DEFAULT to let the linter find it .openapirc.yml
OPENAPI_SPECTRAL_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
OPENAPI_SPECTRAL_DISABLE_ERRORS Run linter but consider errors as warnings false
OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use spectral in your favorite IDE to catch errors before MegaLinter !

IDE Extension Name Install
stoplight Native integration Visit Web Site
Visual Studio Code vscode-spectral Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 113 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 48 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 60 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 50 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 51 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 57 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 51 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 58 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 48 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 48 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 51 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 48 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 53 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .yml, .yaml, .json
  • Detected file content (regex): "openapi":, "swagger":, openapi:, swagger:

How the linting is performed

  • spectral is called one time by identified file (file CLI lint mode)

Example calls

spectral lint myfile.yml
spectral lint -r .openapirc.yml myfile.yml

Help content

spectral lint [documents..]

lint JSON/YAML documents from files or URLs

  documents  Location of JSON/YAML documents. Can be either a file, a glob or fetchable resource(s) on the web.  [array] [default: []]

      --version                  Show version number  [boolean]
      --help                     Show help  [boolean]
  -e, --encoding                 text encoding to use  [string] [choices: "utf8", "ascii", "utf-8", "utf16le", "ucs2", "ucs-2", "base64", "latin1"] [default: "utf8"]
  -f, --format                   formatters to use for outputting results, more than one can be given joining them with a comma  [string] [choices: "json", "stylish", "junit", "html", "text", "teamcity", "pretty"] [default: "stylish"]
  -o, --output                   where to output results, can be a single file name, multiple "output.<format>" or missing to print to stdout  [string]
      --stdin-filepath           path to a file to pretend that stdin comes from  [string]
      --resolver                 path to custom json-ref-resolver instance  [string]
  -r, --ruleset                  path/URL to a ruleset file  [string]
  -F, --fail-severity            results of this level or above will trigger a failure exit code  [string] [choices: "error", "warn", "info", "hint"] [default: "error"]
  -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
      --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
      --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
  -v, --verbose                  increase verbosity  [boolean]
  -q, --quiet                    no logging - output only  [boolean]

Installation on mega-linter Docker image