Installing openapi-changes

Get up and running in seconds.

---

Installing with Homebrew

The quickest way to install openapi-changes on macOS or Linux is Homebrew:

brew install pb33f/taps/openapi-changes

---

Installing with npm or yarn

If you prefer JavaScript package tooling, install it globally with your preferred package manager:

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

---

Installing with cURL

For CI workflows or environments without a package manager, use the installer script:

curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh

---

Running with Docker

If you do not want to install anything locally, pull the Docker image:

docker pull pb33f/openapi-changes

Then mount the working directory and run a command inside the container:

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

The published image is configured to trust mounted git repositories, so history-based commands work inside the container without requiring manual Git safe.directory setup.

---

Verify the install

To confirm the binary or container is wired correctly, print the raw version string:

openapi-changes version docker run --rm pb33f/openapi-changes version

---

Windows

We do not currently publish to a Windows package manager, but Windows binaries are available in the GitHub releases.

---

Check out the code and build from scratch

If you want to build the binary yourself, clone the repository and use Go or Make.

openapi-changes currently requires Go 1.25.0.

git clone https://github.com/pb33f/openapi-changes.git

Build with Make

make

The binary will be written to bin/openapi-changes.

Build with Go

go build -o bin/openapi-changes .