syllable-sync

Reconciles the Syllable CLI Go codebase with an updated OpenAPI spec.

1|Updated Mar 13, 2026
One-click install
npx skills add https://github.com/asksyllable/syllable-cli --skill syllable-sync-asksyllable
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: syllable-sync
Source: https://github.com/asksyllable/syllable-cli/tree/main/.claude/skills/syllable-sync
Command: npx skills add https://github.com/asksyllable/syllable-cli --skill syllable-sync-asksyllable

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? When the Syllable backend API changes, the Go-based CLI drifts out of sync with the published OpenAPI spec. This Skill automates the reconciliation workflow: diffing the old and new specs, identifying added or removed endpoints and schemas, updating Go command files, refreshing documentation, and running tests so the CLI always matches the API. ## Core Features & Use Cases - Structured Spec Diffing: Runs a Python script that reports new, removed, and changed paths, schemas, and enum values, flagging breaking enum removals. - Guided Code Updates: Provides an eight-phase workflow covering spec replacement, Cobra command implementation following existing cmd file patterns, registration in root.go, and integration test requirements. - Documentation Sync: Updates README.md command sections and the AGENTS.md resource overview table to match spec changes. - Use Case: The backend team publishes a new openapi.json with a widgets endpoint. Run this Skill to diff the specs, generate cmd/widgets.go, register the command, add integration tests, and commit the spec, code, and docs together. ## Quick Start Ask the AI to sync the CLI to the latest OpenAPI spec from the TypeScript SDK repo and update the Go commands, tests, and docs accordingly.

Frequently Asked Questions about syllable-sync

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

FAQPage Schema
How do I sync a CLI with a new OpenAPI spec?

Download the new openapi.json, run the diff_specs.py script against the embedded spec to identify changes, then update the Go cmd files, register new commands in root.go, and refresh the docs. The Skill walks through each phase in order.

How do I diff two OpenAPI spec files?

Run diff_specs.py with the old and new spec files as arguments. It reports new, removed, and changed paths, schemas, and enums, with a --format json flag for machine-readable output and --exit-code for CI usage.

Does the diff script detect breaking changes?

Yes. It flags removed paths, removed schemas, removed fields, and removed enum values as breaking. Enum removals are called out explicitly since they are invisible to field-level schema diffs.

What dependencies does the spec diff script need?

The diff_specs.py script uses only the Python 3 standard library (json and sys), so no external packages are required. The broader workflow needs Go installed to build and test the CLI.

When should spec and code changes be committed?

Always commit the embedded spec update and the code implementing it in the same PR, never a spec-only bump. The Skill recommends separate logical commits for the spec, code changes, and documentation.