Skip to Content

gtmesh reference

Prints a reference table’s schema, so you author its CSV against a known contract instead of guessing columns.

gtmesh reference [table]

What it does

A reference table’s schema is largely latent in your config — the engine only reads a small, derivable set of columns per table (for signals: the key column, match, role). gtmesh reference resolves that from the config and prints it: the columns, which are required, what each one means, and — where a column draws its vocabulary from config — the allowed values.

Entities are not a reference table — they live in the committed graph, authored with graph upsert / page add, so there’s no entities.csv schema to describe.

Omit the table name to list which tables are describable. It’s read-only.

There is no write verb — you author the CSV yourself (the engine ignores free-text columns like notes anyway) and run validate, which reports any bad row with a precise row N, column X message.

Arguments & flags

OptionDescriptionDefault
[table]The table to describe (signals); omit to list describable tableslist all

The global options (--project, --json, --quiet) also apply — --json emits a stable schema object.

Reads & writes

  • Consumes: gtmesh.config.yaml (the table declarations + the axes/enums that shape each schema).
  • Produces: a schema report to your terminal. Read-only.
  • Commits: nothing.

Examples

gtmesh reference # list the describable tables gtmesh reference signals # the key column, `match`, `role` — required/optional and what each means gtmesh reference signals --json
  • validate — check an authored CSV against the schema.
  • config — where the columns and enums come from.
  • Reference — the version-exact behaviour.
Last updated on