https://github.com/mazipan/webperf-psi

🚀 Easy to use, PSI API hit using Node.js to collect Web Performance Metrics
https://github.com/mazipan/webperf-psi

pagespeed-insight pagespeed-insights-api web-performance-reports

Last synced: about 2 months ago
JSON representation

🚀 Easy to use, PSI API hit using Node.js to collect Web Performance Metrics

• Host: GitHub
• URL: https://github.com/mazipan/webperf-psi
• Owner: mazipan
• License: mit
• Archived: true
• Created: 2020-04-08T04:54:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-09-12T18:45:35.000Z (over 4 years ago)
• Last Synced: 2025-03-12T00:06:38.145Z (2 months ago)
• Topics: pagespeed-insight, pagespeed-insights-api, web-performance-reports
• Language: JavaScript
• Homepage:
• Size: 137 KB
• Stars: 13
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚀 webperf-psi

Easy to use, PSI API hit using Node.js to collect Web Performance Metrics

![Run CLI](https://github.com/mazipan/webperf-psi/workflows/Run%20CLI/badge.svg?branch=master)

![Usage example](screenshoot.png)

## Get your own API Key

Visit [https://developers.google.com/speed/docs/insights/v5/get-started](https://developers.google.com/speed/docs/insights/v5/get-started)

## Usage

- **With `npx`, using interactive mode**

```bash

$ npx webperf-psi

```

- **With `npx`, using CLI mode**

```bash

$ npx -p webperf-psi webperf-psi-cli --u={YOUR_PAGE} --k={API_KEY}

```

Available arguments:

| Args  | Desc 						   | Required  | Default Value  |

|-------|--------------------|-----------|----------------|

| `u`   | Url to be tested   |  yes 		 | -  						|

| `k`   | API Key  					 |  yes 		 | -  						|

| `d`   | Device  					 |  no 		 	 | mobile  				|

| `h`   | Number of hit PSI  |  no 			 | 1  						|

| `q`   | Quantile  				 |  no 			 | 0.75  					|

- **Run in your local**

Fork, then just run:

```bash

$ pnpm install

$ pnpm run psi

```

## Support

You can support me by just giving a ⭐ in this repository

---

© 2020 Crafted by Irfan Maulana