Install vacuum via homebrew

This the recommended approach.

If you’re on MacOS or Linux, the easiest way to install vacuum is via homebrew.

brew install daveshanley/vacuum/vacuum

Lint your OpenAPI Specification

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

vacuum lint -d my-openapi-specification.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: