Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.typesync.org/llms.txt

Use this file to discover all available pages before exploring further.

Checks if the specified schema definition is syntactically valid.
This command validates the schema files themselves. To validate documents that already exist in Firestore, use validate-data.

Usage

typesync validate --definition <filePathOrPattern> --debug <debug>

Options

definition
string
required
The exact path or a Glob pattern to the definition file or files. Each definition file must be a YAML or JSON file containing model definitions.
  • Example single file path: definition/models.json
  • Example Glob pattern: 'definition/**/*.yml'
debug
boolean
default:false
Whether to enable debug logs.