Pull Schema

Download schema definitions from a workspace to local JSON files. Saves each schema as <slug>/schema.json (metadata) plus <slug>/payload_schema.json (the JSON Schema) in the output directory. Pass a slug as a positional argument or via --slug to pull a single schema, or omit to pull all.

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

Syntax

suprsend schema pull [<slug>] [flags]

Flags

Flag	Description	Default
`-h, --help`	Show help for the command	–
`-d, --dir string`	Directory to save schema files to	`./suprsend/schemas`
`-F, --force`	Skip directory confirmation prompt, use default path	–
`-m, --mode string`	Version mode (`draft` or `live`)	`live`
`-g, --slug string`	Schema 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

Getting Started with CLI

Updates and Versioning

Sync

CI/CD

Workflow

Template

Schema

Event

Preference Category

Translation

Syntax

Flags

Example

​Syntax

​Flags

​Example

Syntax

Flags

Example