sr-compat-check

To detect breaking changes in CLI flags and config keys, snapshot your current API surface and diff it against a stored baseline. The tool validates inputs, computes diffs, and classifies changes into breaking and advisory categories.

API surface compatibility checking audits defined contract surfaces like command names, argument flags, and template placeholders against a prior baseline. It identifies backwards incompatible modifications and generates migration plans when breaking changes are detected.

You generate a migration plan for API surface changes by running a diff against your stored baseline with the propose flag. The tool validates the current contract surface, categorizes modifications by severity, and produces a guide for migrating affected code.

Yes, you can check compatibility for agent names and template placeholders. The tool audits these defined surface elements alongside CLI flags and config keys, computing diffs against a baseline to ensure backwards compatibility.

Yes, the compatibility checking tool supports dry-run workflows. It offers phased operation through flags like snapshot, diff, since, propose, and dry-run to manage and validate API contract changes before applying them.

The best way to automate backwards compatibility checks for APIs is to snapshot the current surface and compare it against a stored baseline. This automated diffing process classifies changes by severity and generates migration plans when needed.