event-modeling-to-eventcatalog

Convert Qlerify JSON event modeling exports into EventCatalog Markdown artifacts and JSON schemas.

14|Updated May 28, 2024
One-click install
npx skills add https://github.com/cameronraysmith/vanixiets --skill event-modeling-to-eventcatalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: event-modeling-to-eventcatalog
Source: https://github.com/cameronraysmith/vanixiets/tree/main/modules/home/ai/skills/src/core/event-modeling-to-eventcatalog
Command: npx skills add https://github.com/cameronraysmith/vanixiets --skill event-modeling-to-eventcatalog

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jaq, duckdb, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the conversion of Qlerify Event Modeling JSON exports into EventCatalog Markdown artifacts, streamlining the documentation of event-driven systems.

Core Features & Use Cases

  • Automated Artifact Generation: Creates MDX files and JSON schemas for events, commands, queries, services, and flows.
  • Data Analysis: Leverages tools like jaq and duckdb to analyze the structure and relationships within the Qlerify export.
  • Use Case: After an event storming session using Qlerify, use this Skill to instantly generate the foundational documentation for your EventCatalog, ensuring consistency and reducing manual documentation effort.

Quick Start

Transform the Qlerify JSON export located at 'path/to/your/export.json' into EventCatalog artifacts.

Frequently Asked Questions about event-modeling-to-eventcatalog

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

FAQPage Schema
How do I convert Qlerify event modeling exports into EventCatalog markdown?

EventCatalog documentation generation for event-driven architectures requires a JSON export from Qlerify containing your event modeling data. The Skill analyzes this input to map service boundaries, event structures, and command definitions into the required EventCatalog format.

How do I generate JSON schemas and MDX files from an event modeling JSON export?

Generating JSON schemas and MDX files from an event modeling JSON export involves analyzing event structures, command/query definitions, and service boundaries using jaq and duckdb. This Skill automates that transformation, producing the structured Markdown artifacts required by EventCatalog.

Do I need jaq and duckdb installed to transform Qlerify JSON for EventCatalog?

Yes, you need jaq and duckdb installed to transform Qlerify JSON for EventCatalog. These dependencies are required to query and analyze the complex data structures and relationships within the Qlerify export before generating the final Markdown artifacts.

Can I automate EventCatalog documentation generation after a Qlerify event storming session?

You can automate EventCatalog documentation generation after a Qlerify event storming session by processing the session's JSON export with this Skill. It instantly creates foundational MDX files and JSON schemas, ensuring consistency and reducing manual documentation effort for your event-driven system.

What are the limitations of using JSON querying tools for event-driven architecture documentation?

Limitations of using JSON querying tools like jaq and duckdb for event-driven architecture documentation include strict adherence to EventCatalog's expected structure and reliance on the completeness of the Qlerify JSON export. Complex data flows require accurate source modeling to generate valid artifacts.