mine-sync

Synchronize MINE-managed design documents to match actual repository code.

16|Updated Jul 23, 2026
One-click install
npx skills add https://github.com/6ixGODD/mine --skill mine-sync-6ixgodd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mine-sync
Source: https://github.com/6ixGODD/mine/tree/main/plugins/mine/skills/mine-sync
Command: npx skills add https://github.com/6ixGODD/mine --skill mine-sync-6ixgodd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Design documentation drifts out of sync with the actual codebase as repositories evolve, leaving agents and engineers with contradictory or outdated engineering context. This Skill reconciles MINE-managed design with repository reality using a code-first authority model. ## Core Features & Use Cases - Code-first synchronization: Rewrites docs/design/ to match observable code, schemas, and configuration, with code winning by default unless the user explicitly protects a design decision. - Mandatory verified backup: Creates a verified local backup of the design tree before any mutation, blocking synchronization if backup verification fails. - Discrepancy classification and reporting: Classifies drift (missing design, removed behavior, protected decisions, suspicious code) and writes a sync report under .mine/runtime/sync/ with a final status of SYNCHRONIZED, SYNCHRONIZED_WITH_WARNINGS, or BLOCKED. - Use Case: After onboarding an existing repository or making substantial out-of-band changes, run a sync to audit the codebase, update the design tree, and receive a report of unresolved risks before a stable release. ## Quick Start Ask the agent to run mine-sync to audit this repository and update the design documents to match the current code.

Frequently Asked Questions about mine-sync

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

FAQPage Schema
How do I sync design documentation with my existing codebase?

Run mine-sync to inventory the repository, map code to design documents, and rewrite the managed design tree to match current code. It creates a verified backup first and produces a sync report classifying every discrepancy found.

What is the difference between mine-sync and mine-arch?

mine-sync is code-first: it makes design describe the repository that already exists. mine-arch is requirement-first: it creates a target design from requirements that may intentionally differ from current code.

Does mine-sync modify my business code?

No. mine-sync only writes to MINE-managed design documents and its local sync report. Needed code changes discovered during sync are handed off to the plan-create and execution flow as a separate explicit step.

What happens if my docs/design directory has no MINE marker?

Synchronization stops on a legacy unmarked docs/design directory to avoid overwriting unknown content. Running mine init backs up the legacy directory automatically and creates a fresh managed root, after which sync can proceed.

Can I protect specific design decisions from being overwritten?

Yes. Explicitly named user-protected decisions take top priority in the authority order. The sync preserves the protected design, reports the implementation drift, and requires planning before release closure.