Mergeway Documentation

Synopsis: Print the normalized schema for a given entity.

Usage

mergeway-cli [global flags] entity show <entity>

No additional flags. Use --format json if you prefer JSON output, and add the global --root flag when working outside the workspace root.

For inherited entities, the output shows the effective flattened schema, including inherited fields. The normalized output also preserves extends metadata so the inheritance chain remains visible.

Example

Show the Post entity in YAML form:

mergeway-cli --root examples/full --format yaml entity show Post

Output (abridged):

name: Post
source: .../examples/full/entities/Post.yaml
identifier:
  field: id
filepatterns:
  - data/posts/*.yaml
fields:
  title:
    type: string
    required: true
  author:
    type: User
    required: true
  body:
    type: string

Related Commands

• mergeway-cli entity list — find available entities.
• mergeway-cli config export — generate a JSON Schema from an entity definition.