Get started with Snowtype

info

This documentation only applies to Snowplow BDP. See the feature comparison page for more information about the different Snowplow offerings.

Introduction to the Snowtype CLI

Snowtype is a command-line interface that assists developers in implementing custom Snowplow tracking faster, more accurately and more intuitively. Since Snowplow events are always bound to a schema to ensure data quality, we can use this feature to enable type-checking, provide inline documentation and reduce time writing custom code. All that integrated into your development workflow.

Prerequsites

To use Snowtype, you must have Node.js (>=@18) installed.

Installation

Navigate to your project and install Snowtype using your favorite package manager:

npm

npm install --save-dev @snowplow/snowtype

Yarn

yarn add --dev @snowplow/snowtype

pnpm

pnpm add --save-dev @snowplow/snowtype

Executing commands

Installing Snowtype will also create a local executable snowtype which you can use with npx, yarn or pnpm directly when on your project's directory.

npm

npx @snowplow/snowtype init
# Same as
npx snowtype init

Yarn

yarn @snowplow/snowtype init
# Same as
yarn snowtype init

pnpm

pnpm @snowplow/snowtype init
# Same as
pnpm snowtype init

We will show example commands using npm/npx but it should work the same with any other package manager.