@eventcatalog/cli 0.2.1 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli-docs.mjs CHANGED
@@ -1566,6 +1566,64 @@ var cliFunctions = [
1566
1566
  category: "Utilities",
1567
1567
  args: [],
1568
1568
  examples: [{ description: "Get config file", command: "npx @eventcatalog/cli getEventCatalogConfigurationFile" }]
1569
+ },
1570
+ // ================================
1571
+ // Export (DSL)
1572
+ // ================================
1573
+ {
1574
+ name: "export",
1575
+ description: "Export catalog resources to EventCatalog DSL (.ec) format",
1576
+ category: "Export",
1577
+ args: [
1578
+ { name: "all", type: "boolean", required: false, description: "Export the entire catalog (all resource types)" },
1579
+ {
1580
+ name: "resource",
1581
+ type: "string",
1582
+ required: false,
1583
+ description: "Resource type: event, command, query, service, domain (or plural forms)"
1584
+ },
1585
+ { name: "id", type: "string", required: false, description: "Resource ID (omit to export all of the given type)" },
1586
+ { name: "version", type: "string", required: false, description: "Resource version (defaults to latest)" },
1587
+ {
1588
+ name: "hydrate",
1589
+ type: "boolean",
1590
+ required: false,
1591
+ description: "Include referenced resources (messages, channels, owners)"
1592
+ },
1593
+ { name: "stdout", type: "boolean", required: false, description: "Print to stdout instead of writing a file" },
1594
+ { name: "playground", type: "boolean", required: false, description: "Open the exported DSL in the playground" },
1595
+ { name: "output", type: "string", required: false, description: "Output file path (defaults to <id>.ec or catalog.ec)" }
1596
+ ],
1597
+ examples: [
1598
+ {
1599
+ description: "Export a single service",
1600
+ command: "npx @eventcatalog/cli export --resource service --id OrderService"
1601
+ },
1602
+ {
1603
+ description: "Export a service with all dependencies",
1604
+ command: "npx @eventcatalog/cli export --resource service --id OrderService --hydrate"
1605
+ },
1606
+ {
1607
+ description: "Export all services",
1608
+ command: "npx @eventcatalog/cli export --resource services"
1609
+ },
1610
+ {
1611
+ description: "Export all services with hydration to stdout",
1612
+ command: "npx @eventcatalog/cli export --resource services --hydrate --stdout"
1613
+ },
1614
+ {
1615
+ description: "Export the entire catalog",
1616
+ command: "npx @eventcatalog/cli export --all --hydrate"
1617
+ },
1618
+ {
1619
+ description: "Export entire catalog to a custom file",
1620
+ command: "npx @eventcatalog/cli export --all --hydrate -o my-catalog.ec"
1621
+ },
1622
+ {
1623
+ description: "Export and open in playground",
1624
+ command: "npx @eventcatalog/cli export --resource services --hydrate --playground"
1625
+ }
1626
+ ]
1569
1627
  }
1570
1628
  ];
1571
1629
  function getCategories() {