Documentation article

Run your first transformation

Run one schema through the full pipeline and inspect both the output and the diagnostics.

Guides5 min

The fastest way to understand the toolkit is to move one schema through the full parse -> Shape IR -> generate flow.

A good first transformation is simple enough to inspect by eye but rich enough to show that the IR is doing real structural work for you.

Audience
New users
Difficulty
Beginner
Last updated
July 27, 2026
Playground
Try the interactive route while reading this guide.
Shape IR
Read the deeper explanation of shared semantics after your first run.

Use a representative sample

The first run should teach you where the toolkit is already deterministic and where downstream formats still force tradeoffs.

  • Choose a supported source format such as TypeScript or JSON Schema.
  • Paste a schema with an object, a few primitives, and at least one array or enum.
  • Generate to a different target format and compare the structure, not only the syntax.

Read the result and the diagnostics together

When the transformation succeeds, inspect the resulting schema for preserved field names, container shapes, and obvious constraints.

When you see warnings or caveats, treat them as part of the normal workflow. They tell you where a target format cannot carry the same meaning cleanly.

Start with a compact schema

This kind of compact schema is ideal for a first pass because you can quickly tell whether object properties, arrays, and enums stayed intact.

A compact first input

ts
type Source = {
  id: string;
  tags: string[];
  status: "draft" | "published";
};