Skip to content
Platform Status

CLI

diff

speakeasy diff

Compare spec revisions and show SDK changes

Details

Section titled “Details”

Diff

Section titled “Diff”

Compare OpenAPI spec revisions and show SDK-level changes - how the generated SDK methods, models, and types would differ between two spec versions.

This is different from speakeasy openapi diff which shows raw OpenAPI schema changes (paths, operations, properties). Use this command when you want to understand the impact on your generated SDK code.

This command supports three modes:

Files Mode (Local)

Section titled “Files Mode (Local)”

Compare two spec files directly from disk:

Terminal window
speakeasy diff files --old old-spec.yaml --new new-spec.yaml

From PR Mode

Section titled “From PR Mode”

Look up specs from a GitHub pull request created by Speakeasy:

Terminal window
speakeasy diff from-pr https://github.com/org/repo/pull/123

Registry Mode

Section titled “Registry Mode”

Compare specs by providing registry namespace and digest values:

Terminal window
speakeasy diff registry --namespace my-api --old sha256:abc... --new sha256:def...

Usage

Section titled “Usage”
speakeasy diff [flags]

Options

Section titled “Options”
  -h, --help   help for diff

Options inherited from parent commands

Section titled “Options inherited from parent commands”
      --logLevel string   the log level (available options: [info, warn, error]) (default "info")

Parent Command

Section titled “Parent Command”
  • speakeasy - The Speakeasy CLI tool provides access to the Speakeasy.com platform

Sub Commands

Section titled “Sub Commands”