Install vacuum via Homebrew

This is the recommended approach for macOS.

If you’re on macOS, the easiest way to install the official signed vacuum release is via the Homebrew cask.

brew install --cask daveshanley/vacuum/vacuum

Use the cask when you want the official macOS release binary signed by Quobix. brew install vacuum installs the Homebrew core formula instead; that build is compiled by Homebrew from source and is not the signed upstream release binary.

On Linux, use the installing page for the shell installer, NPM, Docker, or Homebrew core formula options.

Lint your API description

Run the lint command with the -d (details) flag set:

vacuum lint -d my-openapi-specification.yaml

For AsyncAPI, use the same command. vacuum detects AsyncAPI 3 documents and selects the AsyncAPI ruleset automatically.

vacuum lint -d events.asyncapi.yaml

Learn more about the lint command.

Explore the results through the console dashboard

Run the dashboard command:

vacuum dashboard my-openapi-specification.yaml

Learn more about the dashboard command.

Explore the results through an HTML report

Run the html-report command:

vacuum html-report my-openapi-specification.yaml

Learn more about the html-report command.

Ready to learn more? Check out some background behind the project: