Skip to main content
Download schema definitions from a workspace to local JSON files. Saves one JSON file per schema (named by slug) to the output directory. Use --slug to pull a single schema, or omit to pull all.

By default, pulled schemas are stored in the suprsend/schema/ directory, but you can change the destination using the -d flag.

​
Syntax

suprsend schema pull [flags]

​
Flags

FlagDescriptionDefault
-h, --helpShow help for the command–
-d, --dir stringDirectory to save schema files to./suprsend/schema
-f, --forceSkip directory confirmation prompt, use default path–
-m, --mode stringVersion mode (draft or live)live
-g, --slug stringSchema slug to pull (omit to pull all)–

​
Example

# Pull schemas from staging workspace (default)
suprsend schema pull

# Pull schemas from production workspace
suprsend schema pull --workspace production

# Pull individual schema by passing it's slug
suprsend schema pull --slug my-schema

# Pull schemas into custom directory path
suprsend schema pull --dir schemas

# Pull draft schemas from production
suprsend schema pull --mode draft --workspace production