architecture-sync

Validate SERVICE_MAP.yaml and generate Mermaid diagrams and ARCHITECTURE.md documentation.

12|Updated Apr 26, 2026
One-click install
npx skills add https://github.com/krus210/archspec --skill architecture-sync-krus210
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-sync
Source: https://github.com/krus210/archspec/tree/main/skills/architecture-sync
Command: npx skills add https://github.com/krus210/archspec --skill architecture-sync-krus210

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, jsonschema, jinja2, requests, and includes scripts (resource) and assets (resource) and references (resource) components.

What problem does it solve?

This Skill automates the validation and documentation of microservice architectures, reducing manual efforts and ensuring consistency across services.

Core Features & Use Cases

  • Service Initialization: Bootstraps new services by creating SERVICE_MAP.yaml contracts, diagrams, and ARCHITECTURE.md documentation.
  • Validation: Validates SERVICE_MAP.yaml against a schema, checks for inconsistencies, and detects issues like dead code or missing dependencies.
  • Documentation: Generates Mermaid diagrams and ARCHITECTURE.md from SERVICE_MAP.yaml, providing a visual representation of the service architecture.
  • Use Case: Imagine you have a monorepo with multiple microservices. Use this Skill to ensure each service's architecture is well-documented and compliant with the defined contract.

Quick Start

Run the /archspec:sync command in the service directory to synchronize diagrams and architecture documentation from the SERVICE_MAP.yaml.

Frequently Asked Questions about architecture-sync

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

FAQPage Schema
How do I automate microservice architecture validation and documentation?

Automate microservice architecture validation by running the /archspec:sync command, which analyzes SERVICE_MAP.yaml to generate Mermaid diagrams and ARCHITECTURE.md while checking for dependency inconsistencies.

How do I generate Mermaid diagrams from YAML for microservices?

Generate Mermaid diagrams from YAML by defining your microservice dependencies in SERVICE_MAP.yaml and executing the sync command to automatically render visual architecture representations.

What problems does architecture validation solve for a microservice monorepo?

Architecture validation solves consistency issues in a microservice monorepo by detecting dead code, identifying missing dependencies, and ensuring each service complies with defined schema contracts.

Do I need Python and Git to validate microservice architecture contracts?

Yes, you need Python and Git to validate microservice architecture contracts, as the validation process requires Python dependencies and integrates with pre-commit hooks for ongoing maintenance.

Can I use pre-commit hooks for microservice architecture consistency checks?

Yes, you can use pre-commit hooks for microservice architecture consistency checks, applying schema validation to SERVICE_MAP.yaml to prevent missing dependencies and dead code from entering your repository.

How do I discover upstream and downstream relationships in microservices?

Discover upstream and downstream relationships in microservices by integrating reverse scanning with your SERVICE_MAP.yaml, allowing the tool to automatically map and validate service dependencies.