schema command

The schema command lints JSON Schema documents directly. It does not require an OpenAPI document.

The default ruleset is json-schema-recommended.

Lint a schema

Use vacuum schema for a single file.

Use schema lint if you prefer the explicit subcommand. It does the same thing.

Lint a folder

Folder inputs recursively include .json, .yaml and .yml files.

Use --include and --exclude to control folder discovery.

Quote include globs so your shell does not expand them into separate file arguments.

Lint from stdin

Use --stdin or -i to read one schema from stdin.

Bundle before linting

Some exploded JSON Schema packs need to be bundled before linting. Use --bundle to bundle a single root schema in memory, then lint the bundled document.

--bundle is explicit. It only works with one schema file or one stdin input.

Bundle a schema

Use vacuum schema bundle to write a bundled JSON Schema document.

The bundle command rewrites ordinary external $ref values into root $defs.

{
  "properties": {
    "gift": {
      "$ref": "_defs/GiftBag.schema.json"
    }
  }
}

becomes a root $defs lookup.

{
  "properties": {
    "gift": {
      "$ref": "#/$defs/GiftBag"
    }
  },
  "$defs": {
    "GiftBag": {}
  }
}

If a bundled external schema contains a local $defs pointer such as #/$defs/Hat, vacuum will look for a sibling Hat.schema.json file, move it into the root $defs, and preserve the lookup as #/$defs/Hat.

Bundle to stdout

Use --stdout or -o to write the bundled schema to stdout.

This is useful when piping into another tool.

If stdin input contains relative external refs, provide --base so vacuum knows where to resolve them from.

Output format

Bundling preserves the input format by default. Use --format json or --format yaml to override it.

Folder bundling

schema bundle bundles one schema root at a time. Folder bundling is not supported.

Use folder linting when you want to lint many schemas, and use schema bundle when you want to produce one portable schema document from one root schema.

Available Flags

schema supports the following flags.

schema bundle supports the following flags.