compat-check

Snapshot CLI surfaces and compare against baselines to detect breaking changes.

9|2|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/fjpulidop/specrails-core --skill compat-check-fjpulidop
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compat-check
Source: https://github.com/fjpulidop/specrails-core/tree/main/specrails-plugin/skills/compat-check
Command: npx skills add https://github.com/fjpulidop/specrails-core --skill compat-check-fjpulidop

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Snapshots the current API surface of a project (CLI surface, templates, agents, and config keys) and compares it against a baseline to surface breaking changes and guide migrations.

Core Features & Use Cases

  • Surface extraction: derives a structured view of installer flags, template placeholders, commands, and agent definitions from the repository.
  • Baseline diff: compares the current surface to the latest snapshot to classify additions, removals, renames, and signature changes.
  • Migration guidance: generates a migration plan when breaking changes are detected.
  • Propose workflow: supports design-driven projections to explore future changes and evaluate impacts.

Quick Start

Use the compat-check skill to snapshot the current API surface and surface breaking changes.

Frequently Asked Questions about compat-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect breaking changes in a CLI surface before release?▼

Generate migration guidance for breaking API changes by diffing the current API surface against a baseline snapshot, which automatically classifies removals and signature changes to produce a structured migration plan.

What is an API surface snapshot and how does it work for compatibility checks?▼

An API surface snapshot captures installer flags, template placeholders, commands, and agent definitions from your repository, providing a structured baseline to compare against for detecting compatibility changes.

Do I need a Git repository to check CLI compatibility and track breaking changes?▼

Yes, checking CLI compatibility requires a Git repository, a .claude/compat-snapshots baseline folder, and project templates and design documents to properly snapshot and diff the API surface.

Can I propose and evaluate future CLI changes before applying them?▼

Yes, you can propose and evaluate future CLI changes using design-driven projections to explore future API surface impacts, allowing you to assess breaking changes before they are applied.

What's the best way to generate a migration guide for API breaking changes?▼

The best way to generate a migration guide for API breaking changes is to diff the current API surface against a baseline snapshot, which automatically classifies removals and signature changes to produce a structured migration plan.