Installing openapi-changes

Get up and running in seconds.

Installing using homebrew

The easiest way to install openapi-changes is to use homebrew if you’re on OSX or Linux.

We have our own tap available that gives the latest and greatest version.

brew install pb33f/taps/openapi-changes

Installing using npm or yarn

Building a JavaScript / TypeScript application? No problem, grab your copy of openapi-changes using your preference of yarn or npm.

yarn add global @pb33f/openapi-changes npm i -g @pb33f/openapi-changes

Installing using cURL

Do you want to use openapi-changes in a CI/CD pipeline or workflow? Or you don’t want to/can’t use a package manager like brew?

No problem. Use cURL to download and run our installer script.

curl -fsSL | sh

Installing/running using Docker

Love containers? Don’t want to install anything? No problem, use our Docker image.

docker pull pb33f/openapi-changes

Next, run docker using the -rm (remove the container after running) and -v flags (mount local volume).

docker run --rm -v $PWD:/work:rw \ pb33f/openapi-changes summary . sample-specs/petstorev3.json

Installing on Windows

We haven’t yet integrated with a Windows package manager, however we still build Windows binaries (believe it or not, this entire tool was developed on Windows and WSL).

To grab your copy of openapi-changes for Windows, you can pull it from the latest releases on github and download the Windows version for your CPU type.

Check out the code and build from scratch

Want to tinker with the tool? Prefer your own compilations? Trust issues? No problem.

openapi-changes is built using golang, golang 1.18+ must be installed.

git clone

You have two choices for building, the first is to use Make (if you’re on OSX or linux), or you can just build using go build

Using Make

Old school? Like the old ways? Yeah, we get it. So let’s relive the glory days!


Once built, the binary will be located in bin/ and named openapi-changes

Building using go

Basically the same thing that Make does for you, except you get the pleasure of typing it out.

go build openapi-changes.go