Skip to main content

Quickstart

Need data to code against? You're in the right place!

0. Create a project on Snaplet Cloud and follow the onboarding to capture your first snapshot:

Onboarding starting screen

1. Install snaplet CLI:

npm install --dev snaplet

If you're not using a NodeJS package manager, like in CI, then you can install it directly using:

curl -sL https://app.snaplet.dev/get-cli/ | bash

2. Setup snaplet CLI in your local project:

Run this command in your local project root directory.

snaplet setup

A new .snaplet folder is created in your project containing your configuration from Snaplet Cloud.

3. Restore your snapshot:

snaplet snapshot restore

Congratulations - you can start coding against your data.