Snapshot Schema
Get a detailed view of the Directus data model.
Arguments
collection1 collection2 ...(optional) — Specific collections to snapshot. If omitted, shows discovery overview.
Process
No arguments:
- Call
schematool (discovery mode) to list all collections - Display collections grouped by folders
- Show collection count and notes
- Call
With collection names:
- Call
schematool withkeys: ["collection1", "collection2", ...] - For each collection, display:
- Fields table: name, type, interface, required, default, notes
- Relations: field → target collection (type, on_delete)
- Meta: icon, display_template, singleton, versioning, archive settings
- Call
relationstool withaction: "read"for full relation details
- Call
Format output for easy reading — this is useful for understanding what to migrate or document.
Example
Input: posts authors categories
Shows detailed schema for posts, authors, and categories including all fields, relations, and meta configuration.