# Install openapi-diff with Homebrew, pacman

Utility for comparing two OpenAPI specifications. Version 2.1.7 via Homebrew; verified 2026-06-22.

## Install

```sh
sudo av install brew:openapi-diff
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install openapi-diff
```

  Evidence: local Homebrew formula metadata

### Linux

- pacman (92%):

```sh
sudo pacman -S openapi-diff
```

  Evidence: Arch Linux sync databases: openapi-diff from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz

## Package facts

- **Package key:** brew:openapi-diff
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/openapi-diff>
- **Version:** 2.1.7
- **Source summary:** Utility for comparing two OpenAPI specifications
- **Homepage:** <https://github.com/OpenAPITools/openapi-diff>
- **Repository:** <https://github.com/OpenAPITools/openapi-diff>
- **Upstream docs:** <https://github.com/OpenAPITools/openapi-diff#readme>
- **License:** Apache-2.0
- **Source archive:** <https://github.com/OpenAPITools/openapi-diff/archive/refs/tags/2.1.7.tar.gz>
- **Last updated:** 2026-06-22T14:05:41-07:00
- **Generated:** 2026-07-08T07:18:31+00:00

## Executables

- openapi-diff (cli)
- openapi-diff (alias)

## Dependencies

- openjdk

## Build dependencies

- maven

## Install behavior

- Post-install hook: not defined
- Bottle: available on all

## Freshness

- Page generated: 2026-07-08
- Package-manager version: 2.1.7
- Package-manager updated: 2026-06-22
- Local data: ok
- Upstream repository: https://github.com/OpenAPITools/openapi-diff
- Upstream latest detected: 2.1.7 (current)
## Project history and usage

openapi-diff is an OpenAPITools utility for comparing two OpenAPI 3.x specifications and rendering the differences as text, HTML, Markdown, AsciiDoc, or JSON. Its main job is to tell teams whether an API description changed and whether those changes are compatible or incompatible.

### Project history

The repository was created on December 12, 2017 and later moved under the OpenAPITools umbrella. A project discussion for version 2.0.0 on December 5, 2021 described that release as the first stable OpenAPI-Diff release under the OpenAPI Tools organization.

### Adoption history

The project is distributed as Java artifacts on Maven Central, a Docker image under `openapitools/openapi-diff`, and a Homebrew formula. That packaging mix reflects its use both as a library/plugin in Java builds and as a standalone CLI in local or CI workflows.

### How it is used

Developers invoke `openapi-diff <old> <new>` against local files or HTTP URLs, then choose renderers or state-only output. CI users can turn compatibility checks into gates with options such as `--fail-on-incompatible` or `--fail-on-changed`.

Java projects can add the Maven plugin to compare a reference specification against a generated build artifact during tests. The README also documents direct invocation through the core API for custom comparison tooling.

### Why package nerds care

openapi-diff is package-nerd-interesting because it treats API descriptions as build artifacts with semantic compatibility. It turns OpenAPI files from passive documentation into something package managers, CI systems, and release processes can enforce.

### Timeline

- December 12, 2017: the GitHub repository was created. December 5, 2021: the 2.0.0 discussion announced the first stable OpenAPI-Diff release under OpenAPI Tools. January 26, 2026: GitHub releases list version 2.1.7.

### Related projects

- openapi-diff lives in the OpenAPITools ecosystem alongside OpenAPI Generator and shares the same broader OpenAPI/Swagger tooling context.

### Sources

- <https://api.github.com/repos/OpenAPITools/openapi-diff>
- <https://formulae.brew.sh/formula/openapi-diff>
- <https://github.com/OpenAPITools/openapi-diff>
- <https://github.com/OpenAPITools/openapi-diff/discussions/297>
- <https://hub.docker.com/r/openapitools/openapi-diff>
- <https://search.maven.org/artifact/org.openapitools.openapidiff/openapi-diff-core>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals

## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** openapi-diff
- **Version Scheme:** 0
- **Revision:** 0
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** stable

## Other Package-Manager Records

- pacman - openapi-diff - 2.1.7-1: normalized package name match | Arch Linux sync databases: openapi-diff from https://geo.mirror.pkgbuild.com/extra/os/x86_64/extra.db.tar.gz | Utility for comparing two OpenAPI specifications | https://github.com/OpenAPITools/openapi-diff


## Related links

- [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [openjdk](https://www.automicvault.com/pkg/brew/openjdk/) - Runtime dependency declared by Homebrew.
- [maven](https://www.automicvault.com/pkg/brew/maven/) - Build dependency declared by Homebrew.
- [openapi-generator](https://www.automicvault.com/pkg/brew/openapi-generator/) - Shares av.db curated category or tags: api-development, cli, developer-tools, openapi.
- [openapi-tui](https://www.automicvault.com/pkg/brew/openapi-tui/) - Shares av.db curated category or tags: api-development, cli, developer-tools, openapi.
- [kubebuilder](https://www.automicvault.com/pkg/brew/kubebuilder/) - Shares av.db curated category or tags: api-development, cli, developer-tools.
- [oasdiff](https://www.automicvault.com/pkg/brew/oasdiff/) - Shares av.db curated category or tags: breaking-changes, cli, developer-tools, openapi.
- [cargo-public-api](https://www.automicvault.com/pkg/brew/cargo-public-api/) - Shares av.db curated category or tags: breaking-changes, cli, developer-tools.
- [create-api](https://www.automicvault.com/pkg/brew/create-api/) - Shares av.db curated category or tags: cli, developer-tools, openapi.
- [fern-api](https://www.automicvault.com/pkg/brew/fern-api/) - Shares av.db curated category or tags: cli, developer-tools, openapi.
- [graphql-cli](https://www.automicvault.com/pkg/brew/graphql-cli/) - Shares av.db curated category or tags: api-development, cli, developer-tools.
- [openapi-diff](https://www.automicvault.com/pkg/npm/openapi-diff/) - Same normalized package name in another local ecosystem.

## Combined YAML source

View the package source record on GitHub. [combined/openapi-diff.yml](https://github.com/automic-vault/db/blob/main/combined/openapi-diff.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph
