CLI
Run the same diff engine from your terminal and CI.
Install globally:
npm i -g @apidiffguard/cliCommands
| Command | Description |
|---|---|
apidiff login | Authenticate with a browser or API token |
apidiff add | Register an endpoint from URL + method |
apidiff baseline | Capture and optionally approve a baseline |
apidiff check | Run a check against the active baseline |
apidiff diff | Print the latest diff summary to stdout |
apidiff monitor | Daemon mode for local continuous checks |
apidiff import | Import endpoints from an OpenAPI document |
CI example
npx apidiff check --endpoint ep_users --fail-on breakingExit non-zero when breaking changes are detected so the pipeline stops the deploy.