Skip to main content

Getting started with the Snowtype CLI

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 install --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.

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

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