Install 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 shell installer, NPM, Docker, or the Homebrew core formula if you explicitly want Homebrew’s source-built package.

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

Keeping vacuum up to date

vacuum will let you know when a newer stable release is available. The notice appears after normal command output, and it will never upgrade vacuum in the middle of a linting run, or automatically.

To upgrade vacuum, run:

vacuum upgrade

vacuum will use Homebrew, NPM, or the shell installer path when it can detect how it was installed. macOS users who need the signed upstream release should use the Homebrew cask rather than the Homebrew core formula. See the upgrade command for details on update checks and --no-update-check.

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