Inspecting Schemas

The dcupl schemas family is the discovery and escape-hatch tool for the CLI: when you are unsure what fields a ModelDefinition, a loader config, or a TemplateV3 workflow takes, list the built-in schemas and print any of them — optionally with a curated example payload.

Commands

Command Description
dcupl schemas list List all built-in dcupl schemas (models, loaders, workflows, operators).
dcupl schemas get <name> Print the schema source for <name>.
dcupl schemas get <name> --example Print the schema source, then append a curated example payload.
Flag Description
--example Append a curated, copy-pasteable example payload after the schema.

List available schemas

Start by listing every built-in schema to find the exact name you need:

List all schemas
dcupl schemas list

The output groups schemas by category. This abridged sample shows the kind of names you'll see — the real list is longer:

dcupl schemas list (abridged)
Model:
  ModelDefinition
Loader:
  AppLoaderConfiguration
Workflow:
  TemplateV3
Operator:
  ...

Each entry is tagged with its type ([TS] / [Zod]), source package, and a one-line description in the full output.

Pass a schema name to print its source. Add --example to also get a concrete payload you can adapt:

Print a schema with an example
dcupl schemas get ModelDefinition --example

dcupl schemas get <name> --example is the fastest way to learn a schema's exact field names without guessing — no docs lookup required.

Scaffold a workflow template

Because get writes the schema (and example) to stdout, you can redirect it straight into a file to bootstrap a config. This scaffolds a v3 workflow template from the TemplateV3 schema:

Scaffold a workflow template
dcupl schemas get TemplateV3 --example > my.workflow-v3.json

Edit the generated file, then validate and deploy it with the workflow commands.

Next Steps