@generative-dom/cli

Command-line helpers for the Generative DOM monorepo.

Commands

generativeDom create-plugin <name> [--priority <n>]
generativeDom bench
generativeDom validate <file.md>
generativeDom render <file.genui> [-o <out.html>]
generativeDom render --pipe
generativeDom --help
generativeDom --version

create-plugin

Scaffolds a new plugin at packages/plugins/<name>/ using the built-in template. The template produces a minimal GenerativeDomPlugin factory wired to @generative-dom/core. The root tsconfig.json is updated to reference the new package.

bench

Runs pnpm bench:tests from the repository root.

validate <file.md>

Parses a markdown file using GenerativeDom with markdownBase() installed and reports any plugin errors captured via onError. Exits with a non-zero code if any errors were captured.

render <file.genui>

Render a Generative DOM markup file to an HTML string.

generativeDom render document.genui          # → stdout
generativeDom render document.genui -o out.html  # → file
cat document.genui | generativeDom render --pipe  # pipe mode

Uses @generative-dom/string-renderer with the full CommonMark preset internally. Output is raw HTML written to stdout or the specified output file.

Programmatic API

import { createPlugin } from "@generative-dom/cli";

await createPlugin({
  name: "my-plugin",
  priority: 50,
  repoRoot: process.cwd(),
});

import { renderFile } from "@generative-dom/cli";

const html = await renderFile({ file: "document.genui" });
// or from stdin:
// const html = await renderFile({ pipe: true });