Install 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

Install via NPM

npm install -g @quobix/vacuum

Install via yarn

yarn global add @quobix/vacuum

Install via curl

This is perhaps the most simple for CD/CD pipelines.

curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh

Install via Docker.

vacuum is available as a container, pull the image from Docker Hub.

docker pull dshanley/vacuum

To run via docker, add dshanley/vacuum as the docker command, like so:

docker run --rm -v $PWD:/work:ro dshanley/vacuum lint <my-openapi-spec.yaml>

Checkout from source.

git clone https://github.com/daveshanley/vacuum.git Then change directory into vacuum

cd vacuum

Build the code.

go build vacuum.go

Run the code.

./vacuum lint <my-openapi-spec.yaml>

Next Steps

Read more about the linting command.

Check out vacuum on GitHub