Commands
This page only summarizes the CLI commands and the options for each command. For details on which scenarios they can be used, you can go to the Working with the CLI page.
Usageโ
snowtype [COMMAND] [OPTIONS] [CONTEXT-SPECIFIC-OPTIONS]
Available CLI commandsโ
snowtype init
โ
Initialize the setup of Snowtype code generation in a project. Creates the snowtype.config.json
file.
Options
-i, --organizationId
Organization ID.-t, --tracker
Tracker to use. See available-l, --language
Language to use. See available-o, --outpath
Output path.
snowtype generate
โ
Generates tracking code based on configuration on the snowtype.config.json
file. Can generate/modify the .snowtype-lock.json
file.
Options
-is, --instructions
Generate event specification instructions.-va, --validations
Add runtime validation on events. Currently available for the Browser tracker.
snowtype update
โ
Checks for latest version updates in Data Structures and Event Specifications.
Options
-y, --yes
Updates all to latest version without prompting. (default: false)
snowtype patch
โ
Adds new Data Structures and Event Specifications in the snowtype.config.json
file without needing to modify the file by hand.
Options
-e, --eventSpecificationIds
Event Specification ID/s.-p, --dataProductIds
Data Product ID/s.-d, --dataStructures
Data structure schema URI/s.-i, --igluCentralSchemas
Iglu central schema URI/s.
snowtype help
โ
Shows a helpful message and brief instructions for the Snowtype CLI usage.
Global optionsโ
-h, --help
Shows helpful instructions for the command.-V, --version
Output the package version number.-k, --apiKey
Provide the Snowplow Console API key as a CLI option.-v, --verbose
Enable verbose logging.