preferences-event-catalog-qlerify

Convert Qlerify JSON exports into EventCatalog markdown artifacts with JSON Schemas.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the complex process of converting event models defined in Qlerify into discoverable and structured documentation within EventCatalog.

Core Features & Use Cases

  • Qlerify to EventCatalog Transformation: Converts Qlerify JSON exports into EventCatalog-compatible MDX files, preserving algebraic structures.
  • Schema Generation: Automatically generates JSON Schemas for commands, queries, and entities based on Qlerify definitions.
  • Flow Reconstruction: Reconstructs event-driven flows from Qlerify's parent-child relationships.
  • Use Case: You have a Qlerify export detailing your event-driven system. Use this Skill to generate the foundational documentation for your EventCatalog, making your event models easily understandable and navigable.

Quick Start

Use the preferences-event-catalog-qlerify skill to transform the provided Qlerify JSON export into EventCatalog markdown files.

Frequently Asked Questions about preferences-event-catalog-qlerify

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

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

EventCatalog documentation generation from Qlerify JSON involves transforming event models into MDX files. This Skill extracts domains, services, events, commands, and entities to generate structured, discoverable markdown artifacts with preserved algebraic structures.

Can I automatically generate JSON Schemas for commands and queries from Qlerify exports?

Yes, you can automatically generate JSON Schemas for commands, queries, and entities from Qlerify definitions. The transformation process extracts these specific algebraic structures and translates them into standard JSON Schema formats within the markdown output.

How does event-driven flow reconstruction work when transforming Qlerify data to EventCatalog?

Event-driven flow reconstruction works by analyzing Qlerify's parent-child relationships during the extraction process. The Skill cross-references and validates these connections to accurately reconstruct and document the event flows within EventCatalog.

What is the best way to document event-driven systems using Qlerify and EventCatalog?

The best way to document event-driven systems using Qlerify and EventCatalog is by automating the JSON export transformation. This Skill uses discovery queries with duckdb and jaq to phase-extract domains and flows, generating navigable documentation without manual markdown formatting.

Does converting Qlerify exports to EventCatalog MDX preserve aggregates and commands?

Yes, converting Qlerify exports to EventCatalog MDX preserves algebraic structures like events, commands, and aggregates. The transformation process extracts these elements directly from the Qlerify JSON export and maps them into the corresponding EventCatalog documentation format.