When developers install your package, it signals real product usage. With Reo.Dev, you can now identify and monitor installs of your NPM packages. This short guide will walk you through how this works and how you can set it up.

How NPM Install Tracking Works

Once reo-census is added to your package:

1. A developer installs your package using npm install.
2. The reo-census script runs automatically during installation.
3. Installation metadata is sent to Reo’s telemetry endpoint.
4. Reo processes the data and surfaces it as developer activity signals in your dashboard.

Configuring NPM Installs

Simply add reo-census to your package.json. Once done, you can track all de-anonymized developers who have installed your NPM package on Reo.

You’ll get:

• The Package name and version installed
• OS platform, architecture, Node.js version
• Install timestamp
• Git username and email domain (partial mode) or full email (full mode)

{
  "name": "your-package",
  "version": "1.0.0",
  "dependencies": {
    "reo-census": "^1.2.8"
  }
}

<aside> 💡

Note: By default, NPM install tracking works automatically once reo-census is added to your package. No additional setup is required.

</aside>

However, if you want more control over how telemetry works, you can optionally configure tracking behavior by adding a reoSettings block inside your package.json. Here’s how you can set this up: