Skip to content

v1.0.0

Choose a tag to compare

@SethFalco SethFalco released this 12 Nov 22:27
· 3 commits to main since this release
Immutable release. Only release title and notes can be modified.
e646b25

v1.0.0 Release 🎉

Initializes the project and does its job. ^-^'

This generates a browserslist-stats.json file using data from your Plausible Analytics instance. Please see the --help for more information, or read the README.

Usage: browserslist-plausible [options] <site-id>

Generate a browserslist-stats.json file using data from your Plausible Analytics instance.

Arguments:
  site-id                    Domain of the website to query for.

Options:
  -o, --outputPath [string]  Location to write stats in JSON. (default: "browserslist-stats.json")
  -h, --host [string]        Host URL of your Plausible Analytics server. (default: "https://plausible.io")
  -O, --overwrite [boolean]  If to overwrite the output file if it already exists. (default: false)
  --version                  Output the current version of browserslist-plausible.
  --help                     Display this help message.

Basic Usage

Suppose you had a .browserslistrc file with the following query:

.browserslistrc

> 0.5% in my stats

Then, you can do the following commands in your terminal:

npx browserslist-plausible --host https://plausible.example.org example.org
✔ What is your Plausible API Key? *********************************************…
✔ Browserslists stats written to …/browserslist-stats.json

Run the following command to see the Browserslist coverage for your stats:
npx browserslist --coverage --stats=browserslist-stats.json
npx browserslist --coverage --stats=browserslist-stats.json
These browsers account for 87.9% of all users in custom statistics